docs-generator

What problem does it solve?

Maintaining accurate and comprehensive project documentation is a constant challenge, especially in rapidly evolving codebases. Manual documentation quickly becomes outdated, leading to confusion and increased onboarding time for new developers. This skill eliminates that burden by automatically generating detailed documentation directly from your source code.

Core Features & Use Cases

• Automated Codebase Analysis: Intelligently scans your project's architecture, feature structures, state management patterns, and component organization to extract critical information.
• Rich Markdown Documentation: Produces a structured set of Markdown files covering high-level architecture, individual feature details, design patterns, and practical guides, ensuring all aspects of your project are well-documented.
• Visual Architecture Diagrams: Automatically creates Mermaid (or PlantUML) diagrams to visually represent complex architectural concepts, data flows, and feature dependencies, making the codebase easier to understand at a glance.
• Use Case: After a significant refactoring or when preparing for a new team member's onboarding, simply activate docs-generator. It will analyze your entire project and output a complete, up-to-date documentation suite, saving countless hours of manual writing and ensuring everyone has a clear understanding of the codebase.

Quick Start

Use the docs-generator skill to analyze the current project and generate a full set of documentation, including architecture overviews and feature guides.