technical-writer

Generate structured technical documentation with templates, code blocks, and troubleshooting sections.

245|39|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/OneWave-AI/claude-skills --skill technical-writer-onewave-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/OneWave-AI/claude-skills/tree/main/technical-writer
Command: npx skills add https://github.com/OneWave-AI/claude-skills --skill technical-writer-onewave-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps produce comprehensive technical documentation across types (user guides, API docs, tutorials, SOPs, knowledge bases) for technical and non-technical audiences.

Core Features & Use Cases

  • Documentation types: User guides, Developer/API docs, Architecture docs, Tutorials, SOPs, Knowledge bases.
  • Audience-aware: Tailors content for beginner, intermediate, or expert readers.
  • Structured formats: Clear headings, steps, code examples, troubleshooting, and FAQs.

Quick Start

Example: Write a user guide for onboarding new customers to the feature "X" with a quickstart and troubleshooting section.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write API documentation that developers can actually follow?

API documentation should include endpoint descriptions, request/response examples with syntax highlighting, required parameters, error codes, and a quick-start example. This Skill structures API docs with those components, ensuring consistency across all endpoints and reducing developer friction.

What should a user guide include to onboard customers effectively?

A user guide needs clear headings, step-by-step procedures, prerequisites, screenshots or visuals, real code examples, and a troubleshooting section. This Skill enforces that structure and tailors language to your audience's experience level—beginner, intermediate, or expert.

Can I use the same documentation template for different audiences?

No. Beginners need definitions and context; experts need precision and advanced options. This Skill generates audience-aware documentation by adapting language, depth, and prerequisites for each reader level across user guides, API docs, and tutorials.

How do I organize technical documentation so knowledge is findable?

Structure docs with explicit headings, glossary entries, versioned release notes, and a knowledge base format. This Skill applies these templates to user guides, SOPs, and architecture docs, making content searchable and maintainable across your product.

What's the fastest way to close documentation gaps in a large product?

Map missing content by doc type (guides, API docs, tutorials, SOPs), then use structured templates with code blocks, prerequisites, and troubleshooting sections. This Skill eliminates gaps by enforcing complete coverage across all documentation types.