technical-writing

Generate professional technical documentation for software projects.

53|1|Updated Dec 18, 2025

Search Tags:#documentation #guide #readme #api docs #technical-writing

Ready to run

npx skills add https://github.com/cosmix/claude-code-setup --skill technical-writing-cosmix

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/cosmix/claude-code-setup/tree/main/skills/technical-writing
Command: npx skills add https://github.com/cosmix/claude-code-setup --skill technical-writing-cosmix

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill drives the creation of clear, maintainable technical documentation across APIs, systems, and onboarding materials.

Core Features & Use Cases

Structured Documentation: Templates for README, guides, API references, and migration docs.
Audience Awareness: Tailors depth for developers, operators, or business stakeholders.
Documentation Lifecycle: Review, edit, and version controls for docs.

Quick Start

Create a concise README with an architecture section and a quick-start example for a new service.

Frequently Asked Questions about technical-writing

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

FAQPage Schema

How do I write a README that covers installation, usage, and troubleshooting?▼

Structure your README with sections for prerequisites, installation steps, quick-start examples, usage instructions, and a troubleshooting section. This Skill generates professional README templates that organize these components clearly, ensuring developers can onboard quickly and resolve common issues without external help.

What should I include in API documentation?▼

API references require endpoint descriptions, request and response examples, authentication details, error codes, and code samples. This Skill creates structured API docs that present this information consistently across endpoints, making it easy for developers to integrate and debug.

How do I maintain consistent documentation across multiple guides and changelogs?▼

Use templates for user guides, migration guides, and changelogs to enforce consistent structure, tone, and formatting. This Skill provides lifecycle controls for reviewing, editing, and versioning docs so your documentation remains maintainable as your project evolves.

Can I tailor documentation for different audiences—developers, operators, and stakeholders?▼

Yes. This Skill adjusts documentation depth and language based on your audience: technical details for developers, operational procedures for operators, and business context for stakeholders. One source material can generate multiple audience-appropriate versions.

What's the best way to structure a migration guide?▼

Migration guides need a clear overview of changes, step-by-step upgrade instructions, code examples showing before and after, and a troubleshooting section for common blockers. This Skill generates migration templates that guide users through breaking changes with minimal friction.

Do I need technical writing experience to create documentation with this approach?▼

No. This Skill uses structured templates and active-voice guidelines to help you produce professional docs without prior writing experience. Templates handle organization; you provide the technical content and examples.