technical-writing

Generate API documentation and developer guides in Markdown and HTML.

156|21|Updated Oct 25, 2025

Search Tags:#changelog #documentation #readme #swagger #tutorials #api-docs

Ready to run

npx skills add https://github.com/anton-abyzov/specweave --skill technical-writing-anton-abyzov

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/anton-abyzov/specweave/tree/main/plugins/specweave-docs/skills/technical-writing
Command: npx skills add https://github.com/anton-abyzov/specweave --skill technical-writing-anton-abyzov

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Technical writing expertise for API docs, READMEs, tutorials, and changelog management, with a focus on docs-as-code and OpenAPI/Swagger integration.

Core Features & Use Cases

Clear READMEs with usage examples and API references
API documentation patterns, tutorials, and changelog management
Style guides and documentation architecture

Quick Start

Create a README with a quick-start section and an API reference block for a sample endpoint.

Frequently Asked Questions about technical-writing

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

FAQPage Schema

How do I write clear API documentation with code examples?▼

API documentation should include endpoint descriptions, parameter details, request/response examples, and runnable code samples. Structure it with overview sections, organized reference blocks for each endpoint, and executable examples developers can test immediately.

Can I generate documentation from OpenAPI and Swagger specifications?▼

Yes. OpenAPI/Swagger specifications define API contracts that can be transformed into formatted documentation automatically. This approach keeps your API reference synchronized with your actual implementation and supports multiple output formats like Markdown and HTML.

What's the best way to organize a README for a developer project?▼

Structure READMEs with a project description, quick-start section with installation steps, usage examples, API reference links, and contribution guidelines. Lead with the most essential information so developers can begin using your project immediately without hunting through dense text.

How do I manage API documentation across multiple versions?▼

Documentation-as-code workflows version your docs alongside code in version control. Use branching strategies to maintain docs for multiple API versions, automate updates when specifications change, and publish versioned outputs so users access the correct reference for their implementation.

Does technical documentation support automated changelog generation?▼

Changelogs can be automated from commit messages, release tags, or structured change records. Maintaining them as code-driven artifacts ensures consistency, reduces manual effort, and keeps release notes synchronized with actual version changes.

What formats can developer documentation be exported to?▼

Technical documentation workflows produce Markdown for version control and HTML for web hosting. Supporting multiple formats allows developers to read docs in their preferred environment—locally in editors, on documentation sites, or integrated into IDEs.