documente
CommunityAutomates project docs with ADRs, C4, and READMEs
Authoryannzurkinden
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill addresses the overhead of keeping software project documentation in sync by generating and updating ADRs, C4 diagrams, and distributed READMEs from a project structure.
Core Features & Use Cases
- ADR generation and maintenance: Create and update architectural decision records to capture rationale.
- C4 diagrams scaffolding: Produce or adapt context, container, and component diagrams to reflect the current system.
- README distribution: Generate standardized READMEs for src/api, src/services, and src/models, ensuring consistent guidance.
- Template-driven scaffolding: Build a reusable docs skeleton under docs/, architecture/, and guides/ from project content.
- Use Case: Initialize documentation for a new project and keep ADRs and diagrams aligned as the codebase evolves.
Quick Start
Run the documentation generator against the repository root to produce docs/, architecture/, and README distributions. Example: /documente --adr "Initial architecture" path/to/project
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documente Download link: https://github.com/yannzurkinden/masterclass-cc-lausanne/archive/main.zip#documente Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.