technical-documentation
/technical-documentation
Write or update technical documentation that helps a reader use, operate, integrate, or maintain a system. Use for READMEs, API guides, setup instructions, runbooks, architecture notes, and migration docs.
- Author
- helx0071 ↗
- Repository
- skillsmo ↗
- Licence
- MIT
- Last repository change
- 12.11.2026
Assessment and security
- Files in this package
- 3
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 12.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Write or update technical documentation that helps a reader use, operate, integrate, or maintain a system. Use for READMEs, API guides, setup instructions, runbooks, architecture notes, and migration docs.
Original author description
Write or update technical documentation that helps a reader use, operate, integrate, or maintain a system. Use for READMEs, API guides, setup instructions, runbooks, architecture notes, and migration docs.
How it works
- Goal
- Workflow
- Decision rules
- Boundaries
- Completion standard
- Further reading
SKILL.md preview
--- name: technical-documentation description: "Write or update technical documentation that helps a reader use, operate, integrate, or maintain a system. Use for READMEs, API guides, setup instructions, runbooks, architecture notes, and migration docs." --- # Technical documentation ## Goal Make instructions accurate, navigable, and verifiable for the intended reader. ## Workflow 1. Identify audience, task, prerequisites, supported versions, and what the reader should be able to accomplish. 2. Inspect the implementation, configuration, tests, official sources, and existing docs; confirm details before writing. 3. Organize the document around the reader's task, with prerequisites, ordered steps, examples, outcomes, failure recovery, and links. 4. Check commands, paths, headings, relative links, code blocks, and version claims against the current repository. 5. Review for omissions, outdated details, accessibility, and clear ownership/update triggers. ## Decision rules - Use a short README for orientation and linked guides for specialized workflows. - Make examples copyable but safe; use placeholders instead of real credentials or destructive commands. - State assumptions and unsupported cases near the instruction they qualify. ## Boundaries - Do not invent behavior or mark an unverified command as tested. - Do not publish internal addresses, secrets, or proprietary data. ## Completion standard Return the requested artifact or findings with enough evidence for a reviewer to understand what changed, what was checked, and what remains uncertain. Distinguish observed facts, inferred risks, and unverified assumptions. Keep the scope tied to the user's request. ## Further reading - [Field guide](references/field-guide.md) — use for task-specific review questions and edge cases. - [Source and rights notes](references/source-notes.md) — use when maintaining this package or reviewing its provenance.
Files in this package (3)
- SKILL.md 2 KB
- references/field-guide.md 1 KB
- references/source-notes.md 1 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · helx0071/skillsmo | 100 | MIT |
| wondelai/skills | 100 | MIT |
| arcange-dev/veritas-bot | 100 | Apache-2.0 |
| nimadorostkar/Claude-Skills-collection | 100 | MIT |
| kid-sid/codex-spellbook | 100 | MIT |
| magnus919/agent-skills | 95 | MIT |
| JPeetz/agent-skills | 90 | MIT |
Database snapshot: 13.11.2026 · package version 004ff46e30c0 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100documentation
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks. - 95technical-writing
Write clear, comprehensive technical documentation. Use when creating specs, architecture docs, runbooks, or API documentation. Handles technical specifications, system design docs, operational guides, and developer documentation with industry best practices. - 100technical-writing
Create, audit, and maintain technical documentation, READMEs, API references, runbooks, ADRs, onboarding guides, architecture docs, and release notes. Use when technical information must be accurate, usable, and maintainable. - 90Technical Writing
Use for writing technical documentation - architecture decision records, RFCs and design docs, READMEs, API references, tutorials and how-to guides, runbooks, changelogs and release notes, and developer documentation. Also covers information architecture, audience calibration,… - 100technical-writing
Write or revise evidence-backed technical documentation for its intended audience. Use when creating, updating, restructuring, or editing a README, runbook, architecture guide, API guide, spec, or agent-facing instructions. - 100document
Technical documentation expert for creating clear, comprehensive documentation including API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks. Use when creating or improving technical documentation.