write-durable-documentation
Skill1 starsChanged 2 months agoMITView on GitHub
Write a documentation-primary deliverable (README, decision record, runbook, changelog, explanation) with every claim verified against current code. Docs inside a code change stay with engineer-code-change.
In this repository21 other files it gives its agents.
- change-production-data-safelySkill
- craft-contextual-uiSkill
- diagnose-root-causesSkill
- engineer-code-changeSkill
- engineer-reliable-data-pipelinesSkill
- engineer-secure-systemsSkill
- evaluate-agent-behaviorSkill
- handle-sensitive-data-safelySkill
- infer-intent-before-codingSkill
- migrate-contracts-safelySkill
- operate-production-safelySkill
- orchestrate-long-running-workSkill
- plan-decision-complete-changeSkill
- ponytailSkill
- publish-verified-github-changeSkill
- release-production-changesSkill
- respond-to-production-incidentsSkill
- review-code-with-evidenceSkill
- route-ultracode-subagentsSkill
- verify-end-to-endSkill
- write-tests-that-prove-behaviorSkill
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 20
Run every command, snippet, and procedure you document in a representative environment, or mark it explicitly as unverified.
- Distinctive: line 21
Document current behavior.
- Distinctive: line 28
Prefer exact identifiers (paths, commands, flags, versions) over paraphrase, and keep terminology consistent with the code and interface.
- Distinctive: line 29
Keep structure proportionate: headings, tables, and diagrams must earn their place by navigation or comprehension value.
- Distinctive: line 30
Place the document where its owners will find and update it, follow repository conventions, and prefer generating reference material from …
- Distinctive: line 31
Update every neighboring artifact the change makes stale: tables of contents, indexes, cross-references, and now-contradicted claims.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write Durable Documentation
Own accuracy, audience fit, and maintainable placement for documentation-primary work, including an explanation with no file deliverable. Do not implement code, plan changes, or evaluate agents; hand defects found while documenting to their owning workflow.
Establish scope and audience
- Identify the audience, their starting knowledge, the questions the document must answer, and the moment it will be read.
- Find the authoritative home first. Search existing documentation for the subject and update or restructure it rather than adding a parallel document. One authoritative location per subject; link from secondary locations.
- Confirm the deliverable type: explanation, reference, procedure, decision record, or changelog. Each serves a different reader; do not blend them by default.
- Agree what stays out: aspirational behavior, unreleased work, and internal detail the audience cannot act on.
Verify every claim
- Derive statements from code, configuration, tests, schemas, history, and observed behavior, not memory or plausibility.
- Run every command, snippet, and procedure you document in a representative environment, or mark it explicitly as unverified. Record versions when behavior depends on them. Apply operate-production-safely when a documented command targets a live nonlocal environment.
- Document current behavior. Label intended or future behavior as such.
- Date or version drift-prone facts (external URLs, product names, limits, defaults) so staleness is detectable.
- Take examples from real runs. Never fabricate output. Sanitize secrets, credentials, and personal data.
Write for the reader and the maintainer
- Lead with what the reader needs to act; put background and rationale after it.
- Prefer exact identifiers (paths, commands, flags, versions) over paraphrase, and keep terminology consistent with the code and interface.
- Keep structure proportionate: headings, tables, and diagrams must earn their place by navigation or comprehension value.
- Place the document where its owners will find and update it, follow repository conventions, and prefer generating reference material from source when drift risk is high.
- Update every neighboring artifact the change makes stale: tables of contents, indexes, cross-references, and now-contradicted claims.
Stop and ask when
- the audience or deliverable type is ambiguous and the choice changes the document's shape;
- verifying a claim requires access, credentials, or a live environment you are not authorized to use;
- documenting reveals that the code, not the document, is wrong (report it; do not fix it here).
Done when
Every claim is verified by execution or inspection or explicitly marked unverified, the document lives in its authoritative home, and stale neighbors are updated. Report what was verified how, the documents created or changed, the references updated, and any defects handed to engineer-code-change. An explanation delivered in conversation follows the same rules.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

