documentation-writing SKILL.md skillA
documentation-writing from rysweet/amplihack-rs is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rysweet/amplihack-rs/documentation-writing@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rysweet/amplihack-rs
- Path
docs/claude/skills/documentation-writing/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed May 16, 2026
- First version recorded
- May 4, 2026
- Size
- 5,823 bytes
- Repository stars
- 11
- License
- none declared
Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating README files, API docs, tutorials, how-to guides, or any project documentation. Automatically enforces docs/ location, linking requirements, and runnable examples.
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 Writing Skill ## Purpose Creates high-quality, discoverable documentation following the Eight Rules and Diataxis framework. Ensures all docs are properly located, linked, and contain real runnable examples. ## When I Activate I load automatically when you mention: - "write documentation" or "create docs" - "document this feature/module/API" - "create a README" or "write a tutorial" - "explain how this works" - Any request to create markdown documentation ## Core Rules (MANDATORY) ### The Eight Rules 1. **Location**: All docs in `docs/` directory 2. **Linking**: Every doc linked from at least one other doc 3. **Simplicity**: Plain language, remove unnecessary words 4. **Real Examples**: Runnable code, not "foo/bar" placeholders 5. **Diataxis**: One doc type per file (tutorial/howto/reference/explanation) 6. **Scanability**: Descriptive headings, table of contents for long docs 7. **Local Links**: Relative paths, context with links 8. **Currency**: Delete outdated docs, include update metadata ### What Stays OUT of Docs **Never put in `docs/`:** - Status reports or progress updates - Test results or benchmarks - Meeting notes or decisions …
Read the whole file at its exact version.
How to install
mdr add rysweet/amplihack-rs/documentation-writing@sha256:09939ba0370e9b8aThe line at the top of this page pins the label v1.0.0, 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_6zidqfjwcyuwtdhk)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between May 4, 2026 and May 16, 2026, about one every 11 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-05-16 | 6626bc8 | 5,823 B | A | view · diff |
| v1.0.0 | 2026-05-04 | b7ad1ff | 5,830 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 (5823 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
rysweet/amplihack-rs · 11 stars · license none declared · pushed 2026-10-22 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6zidqfjwcyuwtdhk GET https://markdownregistry.com/api/v1/resolve?ref=rysweet/amplihack-rs/documentation-writing GET https://markdownregistry.com/api/v1/blob/09939ba0370e9b8ad39bcef08ce0fad0bccc5c688d2ce9cd0f0042d6446eb228
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 rysweet/amplihack-rs
Every file in rysweet/amplihack-rs