codebase-knowledge-builder

# Codebase Knowledge Builder

> A portable Agent Skill that turns an unfamiliar repository or subsystem into source-cited, reusable working knowledge.

Canonical repository: <https://github.com/OthmanAdi/codebase-knowledge-builder>
Canonical skill: <https://github.com/OthmanAdi/codebase-knowledge-builder/tree/main/skills/codebase-knowledge-builder>
License: MIT

## Start here

- [README](https://github.com/OthmanAdi/codebase-knowledge-builder#readme): purpose, installation, compatibility, limitations, and FAQ
- [Skill instructions](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/skills/codebase-knowledge-builder/SKILL.md): authoritative workflow and safety contract
- [Reconnaissance checklist](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/skills/codebase-knowledge-builder/references/recon-checklist.md): trust-aware preflight and repository inventory
- [Deep-dive methodology](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/skills/codebase-knowledge-builder/references/deep-dive-methodology.md): bounded tracing and evidence synthesis
- [Artifact template](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/skills/codebase-knowledge-builder/templates/knowledge_artifact.md): required provenance, evidence, unknowns, and validation record
- [Worked example](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/examples/distribution-architecture.md): source-cited analysis of the repository's own distribution architecture
- [Security policy](https://github.com/OthmanAdi/codebase-knowledge-builder/blob/main/SECURITY.md): private vulnerability reporting and safe reproduction guidance

## Product boundary

Codebase Knowledge Builder creates reviewable Markdown artifacts. It is not a source packager, persistent index, knowledge graph, hosted service, static analyzer, security scanner, or automatic memory system. The canonical behavior lives only in `skills/codebase-knowledge-builder/`; host manifests package that skill without reimplementing it.

## Evidence vocabulary

- `observed`: directly supported by inspected source or a recorded command receipt
- `inferred`: reasoned from evidence, with confidence and alternatives stated
- `unknown`: not supported by the inspected evidence
- `not applicable`: intentionally outside the scoped research question

Generated artifacts must record the repository revision, scope, exclusions, budget, source locations, target status comparison, and redaction result.