writing-docs skillA
writing-docs is agent-read markdown (skill) from wangchangxin0809/cc-repo-harness: Write or restructure documentation agents and people actually read: which of the four directories it belongs in (how-to, reference, decisions, exec-plans), what belongs in a failure message instead of a file, and keeping the routing table honest. Use for any doc, runbook, README, ADR or plan; when docs are stale, contradictory or ignored; when deciding where a convention lives; when moving knowledge out of CLAUDE.md or agent memory..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# Writing docs an agent will actually use Governs: shared/scripts/context/before_write.py A document is read because something happened. That event is its **reading trigger**, and it decides everything: where the file goes, how long it may be, and what shape it takes. Documents written without one become reference material nobody references. ## Fix the top level; leave the interior free | Directory | Trigger | What it holds | |---|---|---| | `how-to/` | I am about to do a thing | Ordered steps, each ending in an observable criterion | | `reference/` | I need to look up a fact | Facts keyed for lookup, carried by working examples | | `decisions/` | Why is it like this? | Numbered from the PR, dated, superseded rather than edited | | `exec-plans/` | What are we in the middle of? | Goal · steps with state · what would abort it | Four directories, fixed. **Inside each one, organise however suits the material.** Both halves are evidence, not taste: a mandated shallow top level with a free interior is the arrangement that survived a decade across hundreds of OpenStack repositories, while two controlled studies — one on 65 people, one …
Read the whole file at its exact version.
How to install
mdr add wangchangxin0809/cc-repo-harness/writing-docs@git:20260903.c1a383cmdr add wangchangxin0809/cc-repo-harness/writing-docs@sha256:14f6ade0c6ba9301Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_olg3lg5e6akfhzyu)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260903.c1a383c latest | 2026-09-03 | c1a383c | 14,012 B | A | view · diff |
| git:20260902.5318c38 | 2026-09-02 | 5318c38 | 16,109 B | A | view · diff |
| git:20260901.a1c3abe | 2026-09-01 | a1c3abe | 16,029 B | A | view · diff |
| git:20260831.21be719 | 2026-08-31 | 21be719 | 16,035 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 (14012 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
wangchangxin0809/cc-repo-harness · 5 stars · license MIT · pushed 2026-09-23 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_olg3lg5e6akfhzyu GET https://markdownregistry.com/api/v1/resolve?ref=wangchangxin0809/cc-repo-harness/writing-docs GET https://markdownregistry.com/api/v1/blob/14f6ade0c6ba930162b5b42d3ee666c703165bd20b263594b2ac970778f912a5
Your agent 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.
More from wangchangxin0809/cc-repo-harness
Every file in wangchangxin0809/cc-repo-harness