documente

Generate ADRs, C4 diagrams, and READMEs from project structure.

1|Updated Feb 5, 2026
One-click install
npx skills add https://github.com/yannzurkinden/masterclass-cc-lausanne --skill documente
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documente
Source: https://github.com/yannzurkinden/masterclass-cc-lausanne/tree/main/skills_copy/documente
Command: npx skills add https://github.com/yannzurkinden/masterclass-cc-lausanne --skill documente

SYSTEM DOCUMENTATION & REQUIREMENTS

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

Frequently Asked Questions about documente

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate project documentation generation for ADRs, C4 diagrams, and READMEs?

To automate project documentation generation, you can use a template-driven scaffolding approach that creates architectural decision records, C4 context and container diagrams, and distributed READMEs from your existing project structure.

What is the best way to keep architectural decision records and system diagrams in sync as a codebase evolves?

Keeping architectural decision records and system diagrams in sync requires a drift remediation process that automatically updates ADRs and C4 component diagrams to reflect structural changes, ensuring architecture governance and consistent developer handbooks.

Can I generate distributed READMEs for specific source directories like api, services, and models?

Yes, you can generate distributed READMEs for source directories like api, services, and models by deriving standardized guidance content directly from the project structure to ensure consistent developer documentation across modules.

How do I scaffold a reusable documentation skeleton with architecture templates and guides?

To scaffold a reusable documentation skeleton, run a documentation generator against your repository root to populate docs, architecture, and guides directories with standardized templates derived from your project content.

Does this approach to documentation scaffolding require any external dependencies or specific components?

This documentation scaffolding approach operates with no external dependencies or additional components, relying solely on your existing project structure to generate and maintain architecture governance files and developer handbooks.