writing-docs SKILL.md skillA
writing-docs from wangchangxin0809/cc-repo-harness is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add wangchangxin0809/cc-repo-harness/writing-docs@git:20260903.c1a383cPins git:20260903.c1a383c in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- wangchangxin0809/cc-repo-harness
- Path
shared/skills/writing-docs/SKILL.md- Versions recorded
- 4
- Latest version
- git:20260903.c1a383c, committed Sep 3, 2026
- First version recorded
- Aug 31, 2026
- Size
- 14,012 bytes
- Repository stars
- 5
- License
- MIT
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.
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
# 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@sha256:14f6ade0c6ba9301The line at the top of this page pins the label git:20260903.c1a383c, 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_olg3lg5e6akfhzyu)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Aug 31, 2026 and Sep 3, 2026, more than one a day.
| 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-10-30 · 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 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 wangchangxin0809/cc-repo-harness
Every file in wangchangxin0809/cc-repo-harness