codebase-summary

What problem does it solve?

This sop automates the extraction of codebase structure and generates comprehensive documentation, turning complex repositories into accessible knowledge bases for faster onboarding and easier maintenance.

Core Features & Use Cases

• Automated Documentation: Generate architecture, components, interfaces, data models, and workflows from codebases of any size and language.
• Mermaid Visualizations: Produce diagrammatic representations of system relationships to facilitate quick understanding.
• Knowledge Base Artifacts: Create index.md plus architecture.md, components.md, interfaces.md, data_models.md, workflows.md, dependencies.md for AI assistants and developers.
• Use Case: A new contributor can read the generated docs to understand a legacy system and begin contributing within hours.

Quick Start

Invoke the skill against the repository root to generate the documentation set in the designated output directory (e.g., .sop/summary). The skill will produce index.md and per-domain docs such as architecture.md, components.md, interfaces.md, data_models.md, workflows.md, and dependencies.md, including Mermaid diagrams for visualizations.