acquire-codebase-knowledge

Generates seven evidence-based onboarding documents mapping an unfamiliar codebase's stack, structure, and architecture.

28|8|Updated Feb 21, 2022
One-click install
npx skills add https://github.com/Avanade/CoreEx --skill acquire-codebase-knowledge-avanade
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: acquire-codebase-knowledge
Source: https://github.com/Avanade/CoreEx/tree/main/.github/skills/acquire-codebase-knowledge
Command: npx skills add https://github.com/Avanade/CoreEx --skill acquire-codebase-knowledge-avanade

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Onboarding onto an unfamiliar codebase requires hours of manual exploration, and README files often describe intended rather than actual architecture. This Skill automates repository discovery and produces grounded documentation where every claim is traceable to source files or terminal output. ## Core Features & Use Cases - Automated Repository Scanning: Runs a Python scan script detecting manifests for 25+ languages, CI/CD pipelines, containers, security configs, code metrics, and high-churn files. - Seven Structured Documents: Produces STACK.md, STRUCTURE.md, ARCHITECTURE.md, CONVENTIONS.md, INTEGRATIONS.md, TESTING.md, and CONCERNS.md in docs/codebase/ using fill-in templates. - Evidence-First Validation: Enforces a four-phase workflow with a validation loop, marking unknowns as [TODO] and intent-dependent decisions as [ASK USER]. - Use Case: A developer joining a new team runs the skill on the project repository and receives a complete, verifiable onboarding document set covering architecture, conventions, and known technical debt. ## Quick Start Ask the AI to map this codebase and generate onboarding documentation, optionally specifying a focus area such as architecture only.

Frequently Asked Questions about acquire-codebase-knowledge

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate onboarding documentation for an unfamiliar codebase?▼

Run the acquire-codebase-knowledge skill from the project root. It executes a scan script, investigates seven documentation areas, and writes STACK, STRUCTURE, ARCHITECTURE, CONVENTIONS, INTEGRATIONS, TESTING, and CONCERNS documents to docs/codebase/.

How to document a repository's architecture automatically?▼

The skill follows a four-phase workflow: scan the repo, read intent documents like README and PRD, investigate each area using inquiry checkpoints, then populate templates. Every architectural claim must cite a source file as evidence.

What languages and project types does codebase scanning support?▼

The scan script detects manifests for over 25 languages including JavaScript, Python, Go, Rust, Java, .NET, Ruby, PHP, and Elixir. It also detects monorepo tools, CI/CD platforms, Docker and Kubernetes configs, and security tooling.

Can I document only specific areas like architecture or testing?▼

Yes, supply a focus area such as "architecture only" or "testing and concerns". The skill completes focus-area documents first with full detail while keeping required sections present in the remaining documents, marked with [TODO] where unknown.

What are the limitations of automated codebase documentation?▼

The skill only documents what is verifiable from files or terminal output and never infers intent. Team-intent decisions are marked [ASK USER] for manual resolution, and generated directories like dist/ or build/ are excluded from analysis.