Agent skill · writing content · daffy0208
Technical Writer
Create clear, comprehensive technical documentation for developers and users. Use when documenting APIs, writing user guides, creating tutorials, or setting up documentation sites. Covers API docs, user guides, architecture documentation, and documentation best practices.
Why this skill is useful
Provides specific templates and structures for API documentation that the AI wouldn't reliably generate on its own.
What it needs
About 10k tokens when loaded. Last updated 2025-12-25. 33 stars on the source repository.
What this skill does
Technical Writer Great documentation is the difference between a product people use and a product people abandon. Core Principle Write for your audience, not yourself. Good documentation: Answers questions before they're asked Gets users to success quickly Reduces support burden Scales knowledge across teams --- Documentation Types 1. API Documentation Audience: Developers integrating your API Goal: Enable integration without support 2. User Guides Audience: End users Goal: Help users accomplish tasks 3. Tutorials Audience: Learners Goal: Teach concepts through practice 4. Reference Documentation Audience: Developers needing specifics Goal: Quick lookup of parameters, methods 5. Architecture Documentation Audience: Engineers maintaining system Goal: Understand system design decisions --- Phase 1: API Documentation OpenAPI / Swagger Specification API Documentation Structure Authorization: Bearer YOURAPIKEY https://api.example.com/v1 X-RateLimit-Limit: 100 X-RateLimit-Remaining: 99 X-RateLimit-Reset: 1640000000 json { "error": "Invalid email format", "code": "VALIDATIONERROR", "details": { "field": "email", "message": "Must be a valid email address" } } GET /users bash curl -X GET "https://api.example.com/v1/users?page=1&limit=20" \ -H "Authorization: Bearer YOURAPIKEY" json { "data": [ { "id": "usr123", "email": "john@example.com", "name": "John Doe", "createdAt": "2024-01-22T10:30:00Z" } ], "pagination": { "page": 1, "limit": 20, "total": 100, "pages": 5 } } POST /users json { "email": "john@example.com", "name": "John Doe", "role": "user" } bash curl -X POST "https://api.example.com/v1/users" \ -H "Authorization: Bearer YOURAPIKEY" \ -H "Content-Type: application/json" \ -d '{ "email": "john@example.com", "name": "John Doe" }' json { "id": "usr123", "email": "john@example.com", "name": "John Doe", "role": "user", "createdAt": "2024-01-22T10:30:00Z" } bash npm install @example/api-client typescript import { ExampleAPI } from '@example/api-client' const client = new …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills daffy0208/technical-writer