documentation-writer

Guides authoring and auditing of repository docs trees using Diataxis genre conventions.

Updated Aug 2, 2026
One-click install
npx skills add https://github.com/leonardoacosta/agents --skill documentation-writer-leonardoacosta
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/leonardoacosta/agents/tree/main/skills/documentation-writer
Command: npx skills add https://github.com/leonardoacosta/agents --skill documentation-writer-leonardoacosta

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Repository documentation rots when genres are mixed: decisions get edited away, reference pages go stale, and wikis lose trust. This Skill enforces a disciplined docs tree where every page has a clear genre, lifecycle, and machine-checkable freshness signal. ## Core Features & Use Cases - Genre Selection: Decides whether content belongs as an ADR, dated note, reference page, guide, or MOC based on the receipts-vs-state maintenance rule. - Docs Tree Conventions: Defines directory roles (reference/, notes/, guides/, diagrams/), frontmatter contracts (status, updated), dated correction banners, and probe blocks for automated staleness verification. - Domain Modeling: Governs CONTEXT.md glossaries and docs/adr/ decision records with lazy-creation and term-sharpening protocols. - Mermaid Diagrams: Provides a full reference catalog for class, sequence, ER, C4, and architecture diagrams. - Use Case: When asked to document why a team rejected a design alternative, the Skill routes the content to a new ADR in docs/adr/ rather than burying it in a living reference page. ## Quick Start Ask the agent to write or audit documentation for your repository's docs tree, for example by requesting an ADR recording a rejected design decision.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I decide between writing an ADR and updating a reference page?

Ask whether the reasoning stays valuable after the decision is reversed. If yes, write an ADR in docs/adr/ since ADRs are append-only receipts; if the page only describes today's state, update the reference page and link it to the ADR.

What frontmatter should every documentation page have?

Every page carries title, type, domain, tags, status (current, draft, or superseded), and an updated date in YYYY-MM-DD format. The status and updated fields are the machine-checkable freshness signal a staleness sweep reads instead of git mtime.

How do I correct a documentation claim that turned out to be wrong?

Never silently edit away a wrong claim. Add a dated CORRECTION banner directly above it stating what was originally claimed, what it was verified against, and the corrected version, so readers who cached the old claim are not silently contradicted.

When should I create a CONTEXT.md glossary for a repository?

Create CONTEXT.md lazily, only the first time a domain term actually needs sharpening, such as when someone uses a word two different ways or a new contributor asks what a term means. A repo with zero terminology friction correctly carries no CONTEXT.md.

What is a probe block in documentation?

A probe block is a fenced bash code block whose first line is a # probe: comment naming an expected substring, placed beside a countable claim. A docs-sweep tool executes it and flags the doc if the output does not contain the expected string.

Should I use wikilinks in repository documentation?

No. Wikilinks are rejected because GitHub does not render them and they break for any agent reader outside the tool that invented them. Use standard relative Markdown links in pages and MOC index files instead.