write-docs SKILL.md skillA
write-docs from dzhng/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add dzhng/skills/write-docs@git:20260708.50d0752Pins git:20260708.50d0752 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- dzhng/skills
- Path
skills/engineering/write-docs/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260708.50d0752, committed Jul 8, 2026
- First version recorded
- Jul 2, 2026
- Size
- 3,739 bytes
- Repository stars
- 1,377
- License
- MIT
Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.
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
# Write Docs A doc is a **glossary**: it names the moving parts, says why each exists, and carries the principles a reader can't derive by grepping. The code is the source of truth for *what exists right now* — the doc must never race it. Before writing any line, ask the one question that governs this skill: **could the reader get this faster and more reliably by reading the code?** If yes, point them at the code instead of copying it in. ## Keep vs shed Keep — a reader cannot grep their way to these: - The WHY: why a thing exists, the principle behind a split, the taxonomy file names don't reveal. - Non-obvious discoveries: platform quirks, "if you remove this, X breaks because Y", a contract two files silently share. - Pointers to where things live, and what KIND of thing lives there plus the rule for what belongs. Shed — the code or its git history already holds these, so a copy only rots: - Exact rosters: scene names, scenario tables, helper lists, class ids, file lists, command/flag matrices. - Narrative and changelog: "we renamed X", "the old Y was removed as a dup", what was tried and abandoned. …
Read the whole file at its exact version.
How to install
mdr add dzhng/skills/write-docs@sha256:522d8171a7067b20The line at the top of this page pins the label git:20260708.50d0752, 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_5xdpiymklvynfixt)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jul 2, 2026 and Jul 8, 2026, about one every 6 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260708.50d0752 latest | 2026-07-08 | 50d0752 | 3,739 B | A | view · diff |
| git:20260702.e38edde | 2026-07-02 | e38edde | 3,069 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 (3739 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
dzhng/skills · 1,377 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5xdpiymklvynfixt GET https://markdownregistry.com/api/v1/resolve?ref=dzhng/skills/write-docs GET https://markdownregistry.com/api/v1/blob/522d8171a7067b20880b17f389009d7aaa8d38ec4ffdc46af9ae4147e5353eb7
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.