Technical Writer

Generate technical documentation for REST and GraphQL APIs with OpenAPI specs.

34|7|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/daffy0208/ai-dev-standards --skill technical-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Technical Writer
Source: https://github.com/daffy0208/ai-dev-standards/tree/main/SKILLS/technical-writer
Command: npx skills add https://github.com/daffy0208/ai-dev-standards --skill technical-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates confusion and support burden by creating comprehensive technical documentation that helps users succeed without assistance.

Core Features & Use Cases

  • API Documentation: Generate complete OpenAPI specs with authentication, endpoints, and SDK examples.
  • User Guides & Tutorials: Create step-by-step instructions with screenshots and code examples.
  • Use Case: Imagine you've built a new API service. Use this Skill to create complete documentation with authentication guides, endpoint references, error handling, and working code samples in multiple languages.

Quick Start

Use the Technical Writer skill to create API documentation for my user management endpoints.

Frequently Asked Questions about Technical Writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create API documentation from an OpenAPI spec?

API documentation from OpenAPI specs involves structuring your endpoints, authentication details, and request/response examples into a reference format. This Skill generates complete OpenAPI documentation with authentication guides, endpoint references, error handling, and code samples across multiple languages for REST and GraphQL APIs.

What's the best way to write technical documentation for developers?

Technical documentation for developers requires clear structure, working code examples, and searchable organization. This Skill produces comprehensive documentation including user guides, tutorials, API references, and architecture docs with integrated tooling like Docusaurus and MkDocs to keep docs living and version-controlled.

Can I use Docusaurus to set up a documentation site?

Docusaurus is a documentation framework this Skill integrates with for setting up and maintaining documentation sites. It enables versioning, search functionality, and organized doc structure, making it ideal for hosting API documentation, user guides, and tutorials with minimal setup overhead.

How do I document REST and GraphQL APIs with examples?

Documenting REST and GraphQL APIs requires endpoint definitions, authentication patterns, and request/response examples. This Skill handles complete API documentation generation including error messages with solutions, code samples, and integration with common tooling to ensure accuracy and developer usability.

Do I need to manually maintain API documentation versions?

API documentation versioning can be automated through documentation tooling like Docusaurus and MkDocs. This Skill supports versioning strategies and integration with these tools, eliminating manual maintenance and keeping documentation synchronized with API releases.

What should I include in user guides and tutorials?

User guides and tutorials need step-by-step instructions, screenshots, code examples, and clear explanations of complex concepts. This Skill produces structured user guides and tutorials with examples across different scenarios, reducing support burden by helping users succeed independently.