documentation-and-adr

Generates README, CONTRIBUTING, C4 architecture diagrams, and Architecture Decision Records as version-controlled documentation.

Updated Jun 25, 2026
One-click install
npx skills add https://github.com/oriddd/ai-toolkit --skill documentation-and-adr-oriddd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adr
Source: https://github.com/oriddd/ai-toolkit/tree/main/copilot/public/skills/documentation-and-adr
Command: npx skills add https://github.com/oriddd/ai-toolkit --skill documentation-and-adr-oriddd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams lose architectural knowledge when documentation lives in wikis or slide decks that drift out of sync with the code. This Skill keeps README, CONTRIBUTING, C4 architecture diagrams, and Architecture Decision Records (ADRs) inside the repository, reviewed in pull requests and rendered in CI. ## Core Features & Use Cases - Living documentation structure: Defines the required content for README.md, CONTRIBUTING.md, docs/ARCHITECTURE.md, docs/SLO.md, and a docs index so newcomers can navigate a repo in under 60 seconds. - C4 diagrams as code: Produces context, container, and component diagrams in PlantUML or Structurizr DSL, rendered to SVG in CI with a pre-commit check that fails when diagrams are stale. - Architecture Decision Records: Provides an append-only ADR template under docs/adr/ capturing context, decision, consequences, and alternatives for every non-trivial design choice. - Use Case: When scaffolding a new Spring Boot service or choosing Kafka over RabbitMQ, apply this Skill to generate the full docs tree and record the decision as an immutable ADR in the same PR. ## Quick Start Apply the documentation-and-adr skill to generate the README, ARCHITECTURE.md with C4 PlantUML diagrams, and an ADR for the technology choice we just made in this repository.

Frequently Asked Questions about documentation-and-adr

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

FAQPage Schema
How do I write an Architecture Decision Record (ADR)?

Create one Markdown file per decision under docs/adr/ with status, date, deciders, context, decision, consequences, and alternatives considered. ADRs are append-only: supersede an old decision by writing a new ADR rather than editing the original.

How to generate C4 architecture diagrams in CI?

Write diagrams in PlantUML or Structurizr DSL under docs/diagrams/, then render them with the cloudbees/plantuml-github-action using -tsvg. Commit the generated SVGs and add a pre-commit check that fails when a .puml file changed without regenerating its SVG.

When should I write an ADR for a design decision?

Write an ADR when choosing between technologies (Kafka vs RabbitMQ, JPA vs jOOQ), introducing a cross-cutting pattern, selecting a wire format, disabling a security default, or deviating from an established coding standard.

PlantUML vs Structurizr DSL for C4 diagrams?

Both are supported for the three C4 levels (context, container, component). C4-PlantUML is text-first and diffs well in git, while Structurizr DSL models the architecture as a single workspace reused across views.

Why keep architecture documentation in the repo instead of Confluence?

Documentation stored in the repository is reviewed in pull requests, rendered in CI, and stays in sync with the code it describes. External wikis and slide decks drift out of date because nothing forces them to update with the code.