write-docs

"Create or edit documentation, one page at a time, using Diátaxis modes."

brandonocasey 0 Updated 1w ago

Install

npx skillscat add brandonocasey/dotfiles/write-docs

Install via the SkillsCat registry.

SKILL.md

Structure docs by Diátaxis: every page serves exactly one
mode: tutorial (learning by doing), how-to (working task), reference (working
facts), or explanation (learning background). Map an existing repo's folders onto
those modes; in a new docs tree, name the folders after them.
When a section drifts into another mode, move it to the owning page and leave a
one-line link both ways. Do not duplicate content across pages.
Improve docs one page, one flaw at a time; do not plan a whole-docs restructure.
Docs must be useful at every state: no "coming soon" stubs, and don't hold back a
page because it isn't finished.
Each paragraph covers one idea in at most four sentences. Apply
writing.md and repository templates.