reverse-document

Generating design docs from existing source code involves analyzing file structures and reading key implementation files to produce structured planning artifacts such as GDDs and ADRs. The tool outputs drafts for your review before writing them to documentation paths.

Reverse-documentation is the process of inferring design, architecture, and concept documentation from active code and prototypes. It automates filling gaps in GDD and ADR artifacts to align implementation with planning.

You need to reverse-engineer architecture documentation when starting a project with active code that lacks documentation, or when existing design docs are outdated. It helps jump-start design reviews by generating initial planning artifacts.

Yes, you can automatically create ADRs from an existing codebase by running a reverse-documentation command that analyzes your code and prototypes. It produces structured ADR drafts that you review before saving them to the appropriate paths.

Reverse-documentation works with both prototypes and full codebases. The tool analyzes file structures and reads key implementation files from either source to infer design and architecture, producing structured documentation drafts for review.

A limitation of generating GDDs from code is that the output is a structured draft requiring user review before being written to documentation paths. The tool infers design from file structures and implementation files, so accuracy depends on code clarity.