Agent skill · writing content · github
acquire-codebase-knowledge
Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.
Why this skill is useful
Adds a structured documentation process for onboarding into codebases, including specific templates and scanning scripts that the AI wouldn't generate on its own.
What it needs
Requires python installed locally. About 5k tokens when loaded. Last updated 2026-08-07. 37,534 stars on the source repository.
What this skill does
Acquire Codebase Knowledge Produces seven populated documents in docs/codebase/ covering everything needed to work effectively on the project. Only document what is verifiable from files or terminal output — never infer or assume. Output Contract (Required) Before finishing, all of the following must be true: 1. Exactly these files exist in docs/codebase/: STACK.md, STRUCTURE.md, ARCHITECTURE.md, CONVENTIONS.md, INTEGRATIONS.md, TESTING.md, CONCERNS.md. 2. Every claim is traceable to source files, config, or terminal output. 3. Unknowns are marked as [TODO]; intent-dependent decisions are marked [ASK USER]. 4. Every document includes a short "evidence" list with concrete file paths. 5. Final response includes numbered [ASK USER] questions and intent-vs-reality divergences. Workflow Copy and track this checklist: Focus Area Mode If the user supplies a focus area (for example: "architecture only" or "testing and concerns"): 1. Always run Phase 1 in full. 2. Fully complete focus-area documents first. 3. For non-focus documents not yet analyzed, keep required sections present and mark unknowns as [TODO]. 4. Still run the Phase 4 validation loop on all seven documents before final output. Phase 1: Scan and Read Intent 1. Run the scan script from the target project root: Where $SKILLROOT is the absolute path to the skill folder. Works on Windows, macOS, and Linux. Quick start: If you have the path inline: 2. Search for PRD, TRD, README, ROADMAP, SPEC, DESIGN files and read them. 3. Summarise the stated project intent before reading any source code. Phase 2: Investigate Use the scan output to answer questions for each of the seven templates. Load references/inquiry-checkpoints.md for the full per-template question list. If the stack is ambiguous (multiple manifest files, unfamiliar file types, no package.json), load references/stack-detection.md. Phase 3: Populate Templates Copy each template from assets/templates/ into docs/codebase/. Fill in this order: 1. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills github/acquire-codebase-knowledge