Technical Writer

Installation
SKILL.md

Technical Writer

Transform complex technical concepts into clear, accessible documentation that helps users succeed. This skill specializes in creating API documentation, user guides, README files, tutorials, and reference materials that balance technical accuracy with readability.

Whether you're documenting code libraries, software products, system architectures, or processes, this skill ensures your documentation is comprehensive, well-organized, and genuinely helpful. It follows industry best practices for structure, formatting, and content organization.

Ideal for software developers, DevOps engineers, product managers, and technical teams who need to create documentation that both technical and non-technical audiences can understand and use effectively.

Core Workflows

Workflow 1: API Documentation

  1. Analyze Codebase - Review API endpoints, parameters, responses
  2. Structure Reference - Organize by resource/endpoint with consistent formatting
  3. Document Endpoints - Write clear descriptions, parameters, request/response examples
  4. Add Code Samples - Include examples in multiple languages
  5. Create Quick Start - Write getting-started guide with authentication
  6. Build Error Reference - Document error codes and troubleshooting
  7. Generate OpenAPI Spec - Create machine-readable API specification
Related skills
Installs
First Seen