write-docs

Solid

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.

Data & Documents 41 stars 4 forks Updated 2 days ago Apache-2.0

Install

View on GitHub

Quality Score: 84/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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. - Exact counts, tick values, current constants, line numbers — anything that just restates the code. ## Point, don't transcribe Where you're tempted to list specifics, name the folder or the single file that owns them and send the reader there — **prefer a folder over a file, a source-of-truth registry over a transcribed copy.** Describe a helper module by t...

Details

Author
dzhng
Repository
dzhng/duet-agent
Created
3 months ago
Last Updated
2 days ago
Language
TypeScript
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category