documentation-standards SKILL.md skillA
documentation-standards from d-padmanabhan/agent-engineering-handbook is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add d-padmanabhan/agent-engineering-handbook/documentation-standards@git:20260906.8d25679Pins git:20260906.8d25679 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- d-padmanabhan/agent-engineering-handbook
- Path
skills/documentation-standards/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260906.8d25679, committed Sep 6, 2026
- First version recorded
- Aug 18, 2026
- Size
- 7,552 bytes
- Repository stars
- 20
- License
- MIT
Documentation best practices including Markdown formatting, generated PNG diagrams, technical writing, ADRs, Docusaurus and MDX documentation sites, and open source standards. Use when writing documentation, README files, Markdown or MDX content, creating static diagrams for Markdown, configuring Docusaurus, or asking about documentation structure, technical writing, or open source project setup. For interactive React Flow canvases in a SPA, use the reactflow-architecture-diagrams skill instead.
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 Standards
Mandatory documentation gates are owned by the documentation rule (`${HANDBOOK_ROOT}/rules/810-documentation.mdc`), and Markdown-specific gates are owned by the Markdown rule (`${HANDBOOK_ROOT}/rules/800-markdown.mdc`). This skill owns document design, generated PNG guidance, templates, and writing workflows. External documentation research and tool selection are owned by the utilities rule (`${HANDBOOK_ROOT}/rules/120-utilities.mdc`).
## Core Principles
1. **Audience-First**: Write for your reader, not yourself
2. **Keep Current**: Outdated docs are worse than no docs
3. **Show, Don't Just Tell**: Use examples and diagrams
4. **Consistent Format**: Follow established patterns
## Hard Requirements (Writing)
- **No AI slop** - remove filler, keep docs concrete and task-oriented
- **No Unicode em dashes or en dashes** - never author `U+2014` or `U+2013`; use commas, colons, parentheses, semicolons, or ASCII hyphens instead
…Read the whole file at its exact version.
How to install
mdr add d-padmanabhan/agent-engineering-handbook/documentation-standards@sha256:1eed3d69523d1a4cThe line at the top of this page pins the label git:20260906.8d25679, 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.
[](https://markdownregistry.com/a/art_vazif6fdxyupfvrl)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Aug 18, 2026 and Sep 6, 2026, about one every 5 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260906.8d25679 latest | 2026-09-06 | 8d25679 | 7,552 B | A | view · diff |
| git:20260906.0766fec | 2026-09-06 | 0766fec | 7,304 B | A | view · diff |
| git:20260825.8b78171 | 2026-08-25 | 8b78171 | 8,237 B | A | view · diff |
| git:20260819.d23bb73 | 2026-08-19 | d23bb73 | 6,941 B | A | view · diff |
| git:20260818.880e159 | 2026-08-18 | 880e159 | 7,341 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (7552 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
d-padmanabhan/agent-engineering-handbook · 20 stars · license MIT · pushed 2026-10-30 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_vazif6fdxyupfvrl GET https://markdownregistry.com/api/v1/resolve?ref=d-padmanabhan/agent-engineering-handbook/documentation-standards GET https://markdownregistry.com/api/v1/blob/1eed3d69523d1a4c01e8b3fea4c9b40ea0b6202329b6bff3517789af21190493
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.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from d-padmanabhan/agent-engineering-handbook
Every file in d-padmanabhan/agent-engineering-handbook