spec-extract

To generate a specification from an existing codebase, you extract a compact, revision-ready spec that captures module interfaces, invariants, and purpose. This provides a concise map of components and data flow, achieving roughly 1 spec line per 15-25 lines of code for quick architectural review.

Extracting architectural contracts from source code involves identifying module boundaries, public interfaces, and invariants to summarize project topology. This reverse contract extraction outputs a minimal specification that enables revision and architectural review without requiring you to re-read the underlying implementation.

You can use code analysis to create a revision-ready spec for projects up to roughly 5K lines of code. It scales larger projects by focusing specifically on public interfaces, maintaining a target compression of about 1 spec line per 15-25 lines of code while outlining unresolved areas.

To document module boundaries and data flow for an architectural review, you identify entry points and trace topology to summarize project structure. This produces a compact specification outlining the contracts and unresolved areas, serving as a concise map for revision purposes.

When generating documentation from code, you should expect a target compression of roughly 1 specification line per 15-25 lines of code. For a 1500 LOC project, the resulting revision-ready spec would be approximately 60-100 lines, outlining topology and contracts.