SkillDevelopment & Engineering
Choose regression tests for a change
Derive a focused verification set from changed behavior and affected callers.
✳Claude Code
By Dave AIDave AI original
MIT · FreeView skill
Installable skillMIT
Technical Writing for Clarity
Use this skill when writing documentation, READMEs, technical specs, runbooks, or any text that explains a system or process to other engineers. Apply before writing any developer-facing document.
instructions.md
--- name: technical-writing-clarity description: Use this skill when writing documentation, READMEs, technical specs, runbooks, or any text that explains a system or process to other engineers. Apply before writing any developer-facing document. category: communication --- # Technical Writing for Clarity **Principles:** - **Lead with the purpose:** What is this document for and who is it for? - **One idea per paragraph.** Long paragraphs hide key information. - **Use active voice:** `Run the script` not `The script should be run`. - **Concrete over abstract:** Show an example rather than describing it abstractly. - **Avoid jargon** you have not defined unless the audience definitely knows it. **Structure for runbooks/how-tos:** 1. Overview (1–2 sentences) 2. Prerequisites 3. Steps (numbered, imperative) 4. Verification / expected output 5. Troubleshooting **Anti-patterns:** Documenting `what` without `why`, outdated examples, walls of text without headers.--- name: technical-writing-clarity description: Use this skill when writing documentation, READMEs, technical specs, runbooks, or any text that explains a system or process to other engineers. Apply before writing any developer-facing document. category: communication --- # Technical Writing for Clarity **Principles:** - **Lead with the purpose:** What is this document for and who is it for? - **One idea per paragraph.** Long paragraphs hide key information. - **Use active voice:** `Run the script` not `The script should be run`. - **Concrete over abstract:** Show an example rather than describing it abstractly. - **Avoid jargon** you have not defined unless the audience definitely knows it. **Structure for runbooks/how-tos:** 1. Overview (1–2 sentences) 2. Prerequisites 3. Steps (numbered, imperative) 4. Verification / expected output 5. Troubleshooting **Anti-patterns:** Documenting `what` without `why`, outdated examples, walls of text without headers.
COMPATIBILITY & REFERENCES
Platform guidance
Imported from the listed AgentSkill.sh category. Complete supplied package files and notices are retained. Required external tools and credentials are not installed. No bundled code was executed during import. Individual agent task behavior has not been tested.