documenting-architecture
Generate architecture overview documentation from codebase analysis. Uses tree-sitter-analyzer for precise code structure extraction. Generates Mermaid diagrams for visual representation. Triggers: architecture overview, project structure, module diagram, dependency graph, code structure, directory structure.
When & Why to Use This Skill
This Claude skill automates the generation of comprehensive architecture documentation and visual diagrams by performing deep codebase analysis. Utilizing tree-sitter-analyzer for precise structural extraction, it transforms complex source code into clear Mermaid diagrams, dependency graphs, and directory overviews, making it an essential tool for system design visualization and technical documentation.
Use Cases
- Automated Project Onboarding: Generate instant directory structures and tech stack overviews to help new developers understand the project layout and core components quickly.
- Visualizing Module Dependencies: Create dynamic Mermaid relationship diagrams to map out internal and external dependencies, facilitating easier refactoring and system analysis.
- Technical Documentation Maintenance: Keep architecture docs up-to-date by automatically extracting class hierarchies, entry points, and module compositions directly from the source code.
- Codebase Health Auditing: Analyze project statistics, including file counts and language ratios, to gain high-level insights into the technical debt and structural health of a repository.
| name | documenting-architecture |
|---|---|
| description | > |
| allowed-tools | [Read, Write, Grep, Glob, Bash, Task] |
| context | fork |
| user-invocable | false |
Architecture Overview Generation
Detection
| Category | Targets |
|---|---|
| Project Overview | Tech stack, framework, database |
| Directory Structure | tree command output |
| Module Composition | Mermaid relationship diagrams |
| Key Components | Classes, functions, entry points |
| Dependencies | External packages, internal modules |
| Statistics | File count, line count, language ratio |
Project Patterns
| Type | Pattern |
|---|---|
| Node.js | package.json, node_modules/ |
| Python | pyproject.toml, setup.py, __init__.py |
| Rust | Cargo.toml, src/main.rs, src/lib.rs |
| Go | go.mod, main.go, go.sum |
| Java/Maven | pom.xml, src/main/java/ |
| Java/Gradle | build.gradle, src/main/java/ |