acquire-codebase-knowledge

Generate seven evidence-backed codebase documentation files with [TODO] and [ASK USER] markers.

1|Updated Oct 17, 2025
One-click install
npx skills add https://github.com/softwaresalt/csv-managed --skill acquire-codebase-knowledge-softwaresalt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: acquire-codebase-knowledge
Source: https://github.com/softwaresalt/csv-managed/tree/main/.github/skills/acquire-codebase-knowledge
Command: npx skills add https://github.com/softwaresalt/csv-managed --skill acquire-codebase-knowledge-softwaresalt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It helps teams quickly map an unfamiliar repository into clear, actionable documentation by producing a structured overview that is strictly grounded in evidence from existing files or terminal output.

Core Features & Use Cases

  • Verifiable onboarding docs: Generates seven focused documents (stack, structure, architecture, conventions, integrations, testing, and concerns) with every claim traceable to source material.
  • Evidence-first reporting: Includes a concrete evidence list of file paths in each document so readers can audit what was found.
  • No guessing with guardrails: Marks unknowns as [TODO] and intent-dependent decisions as [ASK USER], avoiding unsupported inference.
  • Optional focus-area completion: When the user provides a focus area, the skill prioritizes those documents while still running a final validation pass across all seven.

Quick Start

Run the acquire-codebase-knowledge skill for a repository you want to onboard to and ask it to produce codebase documentation grounded in the current on-disk structure.

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 codebase documentation for onboarding to an unfamiliar repository?

To generate codebase documentation for onboarding, you scan an unfamiliar repository to produce seven structured, evidence-backed documents covering stack, structure, architecture, conventions, integrations, testing, and concerns. Each document maps the codebase using verifiable facts traced directly from source files.

What is evidence-based codebase documentation and how does it handle unknowns?

Evidence-based codebase documentation strictly grounds every architectural claim in existing project files or terminal output. It avoids unsupported inference by marking unknown details as [TODO] and flagging intent-dependent decisions as [ASK USER], ensuring the architecture mapping remains verifiable.

Can I document only a specific focus area within a large codebase?

Yes, you can provide a specific focus area to prioritize generating matching onboarding documents within the large codebase. The system will prioritize those specific documents while still running a final validation pass across all seven required documentation areas.

How do I map software architecture without guessing technical conventions?

You map software architecture without guessing by scanning project files for intent documents and emitting exactly seven structured docs under docs/codebase. Unknowns are marked as [TODO] and intent gaps as [ASK USER], ensuring conventions and integrations are backed by concrete evidence lists.

What are the limitations of automated repository analysis for software onboarding?

The limitation of automated repository analysis is that it never infers unverifiable details. If testing documentation or integration patterns lack source evidence, the onboarding docs will explicitly mark these gaps as [TODO] or [ASK USER] rather than generating speculative explanations.