skills.rest
zenobi-us
zenobi-usOFFICIAL
Explore all skills by this author →
WebsiteGitHub

technical-writer

Write API references, user guides, and developer documentation with examples.

68|6|Updated Apr 16, 2020
Search Tags:#documentation#writing#api#guides#technical
One-click install
npx skills add https://github.com/zenobi-us/dotfiles --skill technical-writer-zenobi-us
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/zenobi-us/dotfiles/tree/main/ai/files/skills/experts/business-product/technical-writer
Command: npx skills add https://github.com/zenobi-us/dotfiles --skill technical-writer-zenobi-us

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill produces high-quality documentation, API references, user guides, and tutorials that reduce support load and enable faster adoption.

Core Features & Use Cases

  • API documentation and user guides with examples
  • Structured content planning, terminology management, and localization readiness
  • Documentation automation and review workflows

Quick Start

Quick Start: Create an API reference page for a sample endpoint with parameter docs and code samples.

Frequently Asked Questions about technical-writer

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 combines parameter specifications, endpoint descriptions, and runnable code samples. This Skill structures API references with examples, terminology management, and accessibility standards to reduce developer onboarding time and support inquiries.

What makes technical documentation readable and accessible?▼

Technical documentation achieves readability through plain language, logical structure, and visual hierarchy. This Skill applies readability scoring above 60, accessibility compliance, and localization readiness to ensure guides work across diverse audiences and contexts.

How do I organize and maintain technical guides across versions?▼

Versioned publishing and structured content planning keep documentation synchronized with product releases. This Skill implements version control, peer review workflows, and maintainability practices so guides stay accurate and current as APIs and features evolve.

Can I automate technical documentation workflows?▼

Documentation automation reduces manual effort through structured templates, review workflows, and publishing pipelines. This Skill supports documentation automation for APIs, user guides, and tutorials, enabling consistent quality across multiple document types.

Why do user guides and tutorials reduce support load?▼

Well-written guides answer common questions before users contact support, accelerating self-service adoption. Task-oriented documentation with examples and step-by-step instructions lower friction and decrease incoming support volume significantly.

What's the best way to structure integration guides for developers?▼

Integration guides combine conceptual overviews, step-by-step procedures, code samples, and troubleshooting sections. This Skill applies structured content planning, technical accuracy verification, and comprehensive examples to help developers adopt SDKs and APIs quickly.

Related Skills

Explore More Content & Communication Skills→
bongrealtybongrealty
2

systems-architect

Generate technical blueprints for web products and SaaS applications.

Community
Advanced
antonyfmunozantonyfmunoz

pinterest

Execute Pinterest API v5 operations to publish pins and analyze performance.

Community
Advanced
spallempatispallempati

pr-review-requirements

Enforce mandatory peer review and automated quality gates on pull requests.

Community
Intermediate
Claude-Code-Community-IrelandClaude-Code-Community-Ireland
10

api-documenter

Automates creation of interactive developer portals and SDKs from OpenAPI 3.1 specifications.

Official
Advanced