software-engineering-docs

What problem does it solve?

Generate and maintain structured software engineering documentation for new or existing applications. Use when asked to create, update, or normalize requirements.md, use_cases.md, specification.md, architecture.md, uml.md, or tests.md from source code and existing docs, and when enforcing consistency and domain boundaries (for example, preventing endpoint-level details in high-level requirements).

Core Features & Use Cases

• Generate documentation sets (requirements.md, use_cases.md, specification.md, architecture.md, uml.md, tests.md) from codebases and existing docs.
• Enforce a canonical system model with stable IDs (FR-###, NFR-###, UC-###, CON-###) and maintain cross-file consistency.
• Support full-generation and doc-grounded-retrieval workflows to adapt to missing or existing docs.
• Use a stepwise workflow: build project context, construct canonical model, then generate and validate docs.

Quick Start

Instruct the system to generate a complete documentation set for a given project by deriving a canonical system model from code and existing docs and producing requirements.md, use_cases.md, specification.md, architecture.md, uml.md, and tests.md.