| name | technical-writing |
| description | Use when drafting or editing persisted technical writing artifacts such as commit messages, issue bodies, PR descriptions, documentation comments, or documentation files. |
Technical Writing
When to use
Use this skill for persisted technical writing artifacts. Do not apply it to normal chat replies.
Core recommendations (should)
- Be concise while preserving required technical detail.
- Prefer explicit nouns over vague pronouns (for example, avoid unclear "this" or "it"). Use pronouns only when the referent is unambiguous.
- Keep wording implementation-focused and directly actionable.
Source handling (must)
- If you reference a source, include a link.
- If a source cannot be linked, do not cite or mention it.
- Integrate relevant information directly when an unlinked source would otherwise be cited.
- If a link is required but unavailable, ask the user for one.
Language constraints (must)
- Use literal technical language.
- Avoid metaphors and idioms.
- Do not use terms like "wiring" or "plumbing" unless describing literal physical context.
Quick self-check
- Is the text concise and complete?
- Are references explicit and unambiguous?
- Does every cited source include a link?
- Is the language literal and free of non-literal idioms/metaphors?
