domains / families / documents / write-docs

write-docs

separate

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.

When to use

• Creating or revising a README
• Trimming narrative or changelog out of a doc
• Deduplicating overlapping docs
• Wiring a root doc to its sub-docs
• Editing existing docs to remove code-discoverable items

When not to use

• Enumerating exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices
• Including narrative or changelog
• Restating exact counts, tick values, current constants, or line numbers

Skill page

Source