Documentation skill for ADRs, READMEs, in-code docstrings, and reference material. Activate when the user asks for documentation, when a public contract changes without docs, or when an ADR is needed per the architect skill's output. Optimized for documents that age well.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Documentation Writer
A skill for writing documentation that survives the first refactor.
Bias toward documents the next reader will actually read.
## When to activate
- The user asks for a README, ADR, architecture doc, or in-code
reference.
- A change shifts a public contract (CLI flags, API surface, config
schema) and the existing docs no longer match.
- The architect skill produced a recommendation that warrants an ADR.
- A new module or component lacks a top-of-file docstring.
Do not activate for:
- Trailing summaries of "what I just did" — those belong in the PR
body, not in standalone docs.
- Inline comments about *what* the code does — code already does that.
- Documentation that nobody asked for, just to look thorough.
## Operating mode
### 1. Identify the reader
Documents written for an unspecified reader become unread. Before
writing, name the reader concretely:
- **Future maintainer** — knows the codebase, needs the *why* and the
invariants. Short, dense.
- **Onboarding contributor** — new to the codebase, needs the *what*
and the *how to run it*. Longer, with examples.
- **External integrator** — does not have repo access, needs only the
…
The line at the top of this page pins the label git:20260615.ac89ffc, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
GET https://markdownregistry.com/api/v1/artifacts/art_pqbwwqedtpg2ojco
GET https://markdownregistry.com/api/v1/resolve?ref=crewrig/crewrig/doc-writer
GET https://markdownregistry.com/api/v1/blob/48c4f71da6d5d6610ad0c3f4c9b9e31ed3825ef89727c383e26ac88672161a27
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
crewrig/crewrig · .agents/skills/architect/SKILL.md · Design and architecture skill for ADRs, RFCs, design reviews, and ripple-effect analysis. Activate when a change…
crewrig/crewrig · .agents/skills/developer/SKILL.md · Implementation skill for writing, modifying, and refactoring code. Activate by default for any coding task that does…
crewrig/crewrig · .agents/skills/doc-writer/SKILL.md · Documentation skill for ADRs, READMEs, in-code docstrings, and reference material. Activate when the user asks for…
crewrig/crewrig · .agents/skills/idea/SKILL.md · IDEA stage lifecycle skill for structured idea-convergence. Activate before a SPECS session whenever multiple…
crewrig/crewrig · .agents/skills/init-expertise/SKILL.md · Create a new expertise (role) file under config/expertise/ through a guided interview. Activate when an adopter wants a…
crewrig/crewrig · .agents/skills/init-personal-profile/SKILL.md · Build your personal profile (config/PROFILE.md) through a guided interview. Collects identity, tooling preferences…
crewrig/crewrig · .agents/skills/init-soul/SKILL.md · Customize the agent identity file (config/SOUL.md) through guided conversation. Walk the user through each section of…
claude-world/director-mode-lite · skills/doc-writer/SKILL.md · Documentation templates and standards: README structure, API reference format, changelog (Keep a Changelog), and…
crewrig/crewrig · .gemini/skills/doc-writer/SKILL.md · Documentation skill for ADRs, READMEs, in-code docstrings, and reference material. Activate when the user asks for…
crewrig/crewrig · .agents/skills/doc-writer/SKILL.md · Documentation skill for ADRs, READMEs, in-code docstrings, and reference material. Activate when the user asks for…
crewrig/crewrig · .github/skills/doc-writer/SKILL.md · Documentation skill for ADRs, READMEs, in-code docstrings, and reference material. Activate when the user asks for…
phuhao00/bony-agent · .agent/skills/doc-writer/SKILL.md · Generates Python docstrings and Markdown documentation. Invoke when user asks to document code or explain functionality.
phuhao00/bony-agent · electron/resources/agent-skills/doc-writer/SKILL.md · Generates Python docstrings and Markdown documentation. Invoke when user asks to document code or explain functionality.
wpfleger96/ai-agent-rules · src/ai_rules/config/skills/doc-writer/SKILL.md · Write, update, or review documentation (README, ARCHITECTURE.md, API docs, guides). Use after implementing features to…