codebase-onboarding
Skill1 starsChanged 2 months agoMITView on GitHub
Auto-generate onboarding documentation from codebase analysis, tailored to the reader's experience level. TRIGGER when: user asks to onboard someone to a codebase, document this codebase, generate project documentation for new team members, write a codebase walkthrough or tour, create a getting-started guide, or explain a codebase to a specific audience. DO NOT TRIGGER when: user wants API reference docs (use language-specific tooling), or wants to understand a single file (just read it).
- Reads credentials
We split this skill into the rules it gives an agent
2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 47 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 58
Keep the glossary to terms a newcomer would not know
- Distinctive: line 60
If the audience is not specified, ask before generating
“Common” is measured: kept by at least 6 in 10 of the 47 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
codebase-onboarding
Auto-generate onboarding documentation from codebase analysis. Audience-aware output for junior developers, senior engineers, and contractors.
What You Get
- Architecture overview derived from actual code structure
- Key entry points and control flow
- Testing strategy and deployment process
- Domain glossary extracted from code and comments
- Audience-tailored depth and focus
Workflow
- Analyze -- Scan the codebase to discover stack, structure, and patterns
- Capture signals -- Identify entry points, config files, CI/CD, test patterns, dependency graph, domain terms
- Fill template -- Populate the output format sections
- Tailor -- Adjust depth and emphasis for the target audience
Analysis signals
| Signal | Where to look |
| Language/framework | package.json, mix.exs, go.mod, Cargo.toml, pyproject.toml |
| Entry points | main files, router definitions, CLI entry points |
| Config | .env.example, config/, settings files |
| CI/CD | .github/workflows/, Makefile, Dockerfile |
| Tests | test/, spec/, tests/, *_test.go |
| Database | migrations/, schema files, ORM models |
| API surface | OpenAPI specs, GraphQL schema, route definitions |
| Domain terms | README, doc comments, module names, type names |
| Dependencies | Lock files, vendor/, package manifests |
| Dev setup | Makefile, docker-compose.yml, devcontainer.json |
Rules
- Derive everything from the actual codebase -- do not fabricate
- Flag gaps explicitly ("No CI/CD configuration found")
- Keep the glossary to terms a newcomer would not know
- Link to actual files using relative paths
- If the audience is not specified, ask before generating
Reference
| File | Topic |
| audience-profiles.md | Junior/Senior/Contractor focus areas |
| output-template.md | Markdown template for the onboarding doc |
Other versions51 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 51
- loulanyue/awesome-claude-notes★ 272same name
- Fmarzochi/EGC★ 61same name
- kumaran-is/claude-code-onboarding★ 35same name
- Hassaan146/claude-skills★ 18same name
- kaizakin/dotfiles★ 16same name
- woxiangyangzhimao/skills★ 14same name
- mxrsv/agents-skills★ 9same name
- gongyijie85/dsh-ecc★ 8same name
- hukusuke1007/agent-skills★ 8same name
- zero-click/zero-ratchet★ 8same name
41 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
Used alongsideProjects with it also use pytorch-patterns, continuous-agent-loop and 9 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
Yog-SothoSkillpytorch-patterns
PyTorch deep learning patterns and best practices for building robust, efficient, and reproducible training pipelines, model architectures, and data loading. Always activate when the user is writing PyTorch models or training scripts, reviewing deep learning code, debugging training loops or data pipelines, optimizing GPU memory or training speed, setting up reproducible experiments, implementing transfer learning or fine-tuning, or asks anything about nn.Module, DataLoader, autograd, AMP, or torch.compile.
Also in 6 projects that use this
junimnjwSkillcontinuous-agent-loop
Patterns for continuous autonomous agent loops with quality gates, evals, and recovery controls.
Also in 7 projects that use this
loulanyueSkillnuxt4-patterns
Nuxt 4 app patterns for hydration safety, performance, route rules, lazy loading, and SSR-safe data fetching with useFetch and useAsyncData.
Also in 4 projects that use this
royaluniondesign-sysSkillcontent-hash-cache-pattern
Cache expensive file processing results using SHA-256 content hashes — path-independent, auto-invalidating, with service layer separation.
Also in 5 projects that use this
- loulanyueSkill
safety-guard
Also in 5 projects that use this
- junimnjwSkill
carrier-relationship-management
Codified expertise for managing carrier portfolios, negotiating freight rates, tracking carrier performance, allocating freight, and maintaining strategic carrier relationships. Informed by transportation managers with 15+ years experience. Includes scorecarding frameworks, RFP processes, market intelligence, and compliance vetting. Use when managing carriers, negotiating rates, evaluating carrier performance, or building freight strategies.
Also in 4 projects that use this
- +3 more from junimnjw
In this repository61 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- adversarial-reviewerSkill
- agent-designerSkill
- architectSkill
- autoresearchSkill
- blockscoutSkill
- ci-cd-pipeline-builderSkill
- claude-apiSkill
- code-reviewSkill
- coingeckoSkill
- database-designerSkill
- dependency-auditorSkill
- design-uxSkill
- digestSkill
- droo-stackSkill
- env-secrets-managerSkill
- ethskillsSkill
- ffmpeg-asmSkill
- focused-fixSkill
- frontend-slop-auditSkill
- git-guardrailsSkill
- git-worktree-managerSkill
- humanizerSkill
- interface-designerSkill
- llm-cost-optimizerSkill
- local-browser-inspectorSkill
- mcp-server-builderSkill
- native-codeSkill
- nixSkill
- noirSkill
- observability-designerSkill
- patchbotSkill
- performance-profilerSkill
- playwrightSkill
- polymathSkill
- prd-to-planSkill
- prepperSkill
- property-testingSkill
- qaSkill
- rag-architectSkill
- raxol-paymentsSkill
- raxolSkill
- raxol-symphonySkill
- recallSkill
- refactoring-strategySkill
- regenSkill
- releaseSkill
- security-auditorSkill
- self-improving-agentSkill
- sentinelSkill
- signozSkill
- skill-creatorSkill
- solidity-auditorSkill
- tddSkill
- tech-debt-trackerSkill
- ubiquitous-languageSkill
- watchdogSkill
- web-asset-generatorSkill
- writing-voiceSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.