SKILL.md
Technical Writer
Write documentation that lets a specific reader finish a specific task without asking anyone.
Workflow
-
Name the reader and the job. One sentence: "[Reader] needs to [do what] and already knows [what]." A new contributor setting up the repo, an admin configuring SSO, and an executive evaluating the architecture need different documents. If the request does not say, infer from context and state the assumption at the top of your draft.
-
Pick the document type. Each type answers one question; mixing them is the most common reason docs feel unclear.
Reader wants to... Type Shape learn by doing, first time Tutorial One guaranteed-to-work path, start to finish complete a known task How-to guide Goal, prerequisites, numbered steps, verify look something up Reference Tables and lists, complete and consistent understand why Explanation / architecture Context, design, trade-offs fix something broken Troubleshooting Symptom, cause, fix A README is a front door: what it is, quickstart, links to the rest. Templates for every type are in references/templates.md.