Agent skill · writing content · aiskillstore
technical-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.
Why this skill is useful
Codifies best practices for technical documentation but AI already knows general writing principles.
What it needs
About 6k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Technical Writing When to use this skill Writing technical specifications Creating architecture documentation Documenting system designs Writing runbooks and operational guides Creating developer documentation API documentation User manuals and guides Release notes and changelogs Instructions Step 1: Understand your audience Developer audience: Focus on implementation details Include code examples Technical terminology is okay Show how, not just what DevOps/Operations audience: Focus on deployment and maintenance Include configuration examples Emphasize monitoring and troubleshooting Provide runbooks Manager/Stakeholder audience: High-level overview Business impact Minimal technical jargon Focus on outcomes End user audience: Simple, clear language Step-by-step instructions Visual aids (screenshots, videos) FAQ section Step 2: Choose the right document type Technical Specification: Architecture Document: Runbook: bash ./deploy.sh production bash ./rollback.sh bash kubectl logs -f deployment/service-name bash curl https://api/metrics API Documentation: bash curl -H "Authorization: Bearer YOURTOKEN" \ https://api.example.com/endpoint GET /api/v1/users bash curl -X GET "https://api.example.com/api/v1/users?page=1&limit=20" \ -H "Authorization: Bearer YOURTOKEN" json { "data": [ { "id": 1, "name": "John Doe", "email": "john@example.com" } ], "pagination": { "page": 1, "limit": 20, "total": 100 } } Step 3: Writing guidelines Clarity: Use simple, direct language One idea per sentence Short paragraphs (3-5 sentences) Define technical terms Avoid jargon when possible Structure: Use hierarchical headings (H1, H2, H3) Break content into sections Use lists for multiple items Use tables for structured data Add table of contents for long docs Examples: Include code examples Provide diagrams Show before/after comparisons Real-world scenarios Completeness: Cover prerequisites Include error handling Document edge cases Explain why, not just how Link to related docs Consistency: Con …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/technical-writing