context-onboarding

Generate documentation for a legacy codebase by scanning its structure, configuration, and routes to infer module boundaries and dependencies. The system proposes a documentation map for user validation, ensuring architecture and interfaces are accurately captured before finalizing the docs.

Documenting a legacy project involves scanning the existing code to map it to a five-piece docset: SPEC, API, CONTEXT, RULES, and CHANGELOG. You validate the inferred module boundaries and dependencies interactively to ensure the reconstructed docs match the actual architecture.

Yes, you can generate a SPEC and API docset automatically for an existing project. The system analyzes code structure and routing to extract interfaces and architecture, deferring business rationale to user input during the validation workflow to complete the documentation.

Identify module boundaries and dependencies by analyzing the codebase's structure and configuration. The system presents a proposed documentation map of the inferred architecture, which you verify and adjust interactively to confirm the actual module scope and relationships.

Codebase onboarding works specifically for existing projects lacking up-to-date docs. It reverse-engineers the current code structure, configuration, and routes to reconstruct comprehensive documentation, rather than generating docs from scratch for a new codebase.

A limitation of reverse-engineering code into documentation is that it cannot infer business rationale and policy decisions. It captures architecture and interfaces from the code, but requires user input during validation to supply the missing business context and rules.