documentation-standard

Write and review Markdown documentation and MADR-format Architecture Decision Records for repositories.

Updated Jun 4, 2026
One-click install
npx skills add https://github.com/tedeuxx/tadeumendonca-skills --skill documentation-standard-tedeuxx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-standard
Source: https://github.com/tedeuxx/tadeumendonca-skills/tree/main/skills/documentation-standard
Command: npx skills add https://github.com/tedeuxx/tadeumendonca-skills --skill documentation-standard-tedeuxx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts from code and architectural decisions get re-litigated by every fresh agent or contributor because nothing records what was decided and why. This Skill enforces a single documentation standard — Markdown + Mermaid only, docs placed next to the code they describe — plus a governed ADR practice so decisions stay durable and discoverable. ## Core Features & Use Cases - General documentation standard: All docs are Markdown with Mermaid diagrams (no static images), with placement rules (a docs/ folder per deployable unit), diagram-type guidance (flowchart, erDiagram, sequenceDiagram), and expected content per file. - ADR practice (MADR): A significance gate decides when an ADR is owed, MADR format records context, options, and consequences, with per-library zero-padded numbering and a proposed → accepted → superseded status lifecycle. - Record disposition rules: Four governed dispositions for retiring or relocating records (delete with History row, fold context into the superseding record, keep, or absorb into a governing document), including the current-codebase rule that replaced supersede-never-delete. - Licensing rule: Every repo carries an MIT LICENSE file with matching manifest fields. - Use Case: A change touches infrastructure in a repo — the Skill tells you an ADR is owed, which library it belongs in (methodology vs product), how to number and format it, and how to retire the record it reverses. ## Quick Start Ask the agent to write an ADR for the infrastructure change in this repo following the documentation-standard skill, or to review the README and architecture docs against the Markdown + Mermaid standard.

Frequently Asked Questions about documentation-standard

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

FAQPage Schema
How do I write an Architecture Decision Record in MADR format?

Copy the docs/adr/template.md file and fill in the MADR sections: title, status, context and problem, decision drivers, considered options, decision outcome, consequences, and links. Number it zero-padded sequentially per library, like 0007-kebab-title.md.

When should I write an ADR for a code change?

Write an ADR when a change crosses a significant boundary: it touches infrastructure, changes a public contract or schema, alters a previously recorded decision, adds a new dependency or tool class, or sets a cross-cutting pattern. Routine in-pattern changes declare no ADR and move on.

Where should documentation files live in a monorepo?

Each deployable unit owns its own docs folder, such as <unit>/docs/ per workspace, never one shared top-level folder. Name files for the question they answer, like architecture.md or data-model.md, and keep diagrams next to the code they describe.

Can I use static images for architecture diagrams in docs?

No. All diagrams must be Mermaid so they stay diffable and versioned alongside the code. Use flowchart for infrastructure and frontend architecture, erDiagram for data models, and sequenceDiagram for flows and integrations.

What happens to an ADR when its decision is reversed?

A reversed record leaves the library through one of four dispositions: delete it with a History row, fold its context into the superseding record first, keep it if proposed or unexercised, or absorb it into the governing document. A deletion without a History row is treated as a gap, not a disposition.

Why quote clauses instead of line numbers when citing ADRs?

Line numbers break silently when another file's whitespace shifts, and nothing in the tooling resolves them. Quoting a clause or heading verbatim keeps citations checkable, and a broken quote surfaces as a finding rather than silent misdirection.