document-module

What problem does it solve?

This Skill turns an existing code module into clear architectural documentation, so teams can understand structure, responsibilities, dependencies, and key flows without manually reverse-engineering the codebase.

Core Features & Use Cases

• Code-scan driven documentation: Analyzes the module’s source files to describe its public API, internal components, and external dependencies.
• Architecture diagrams: Produces C1, C2, and C3 views plus sequence diagrams to explain how the module fits into the wider system and how its main workflows operate.
• Dual outputs: Generates a Markdown source-of-truth document for AI usage and a self-contained HTML version for human readers.
• Use case: Ideal when onboarding a new engineer to an auth, billing, or domain module and you need a reliable architecture overview with traceable evidence from the code.

Quick Start

Ask the skill to document the architecture of the module or folder path you want analyzed, and it will scan the code and generate the module documentation files with diagrams.