skills.rest
grant-vine
grant-vineCOMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate structured developer documentation for APIs, guides, and onboarding content.

1|Updated Mar 6, 2026
Search Tags:#documentation#getting-started#technical-writing#api-documentation#developer-onboarding#how-to-guide#reference-documentation
One-click install
npx skills add https://github.com/grant-vine/wunderkind --skill technical-writer-grant-vine
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/grant-vine/wunderkind/tree/main/skills/technical-writer
Command: npx skills add https://github.com/grant-vine/wunderkind --skill technical-writer-grant-vine

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often inconsistent and hard to maintain for developer-facing APIs and onboarding. This Skill defines a disciplined writer persona to produce accurate, structured, and approachable docs across API references, getting-started guides, tutorials, and developer portals.

Core Features & Use Cases

  • Getting Started guides with Prerequisites, Install, Configure, and First Call templates.
  • Conceptual guides explaining what an API or system is, why it matters, and how it works.
  • How-To guides with goal statements, prerequisites, step-by-step instructions, verification, and troubleshooting.
  • API Reference and Migration guides to support developer onboarding and version transitions.
  • Adherence to documented principles (accuracy, progressive disclosure, concrete examples, scannable structure) and multiple document types.

Quick Start

Create a Getting Started guide for a new service, followed by a Conceptual Guide and an API Reference to enable developers to start quickly.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write developer-friendly API documentation for my new service?▼

To write developer-friendly API documentation, use structured templates for getting started guides, conceptual guides, and API references that ensure accuracy, progressive disclosure, and scannable structure across your developer portal.

What is the best way to create a getting started guide for developer onboarding?▼

The best way to create a getting started guide for developer onboarding is to structure content into Prerequisites, Install, Configure, and First Call templates, ensuring developers can quickly make their first successful API call.

How do I structure how-to guides for an API reference?▼

Structure how-to guides for an API reference by including clear goal statements, prerequisites, step-by-step instructions, verification steps, and troubleshooting sections to help developers follow procedures accurately and resolve issues independently.

Does this technical writing approach support migration notes and version transitions?▼

Yes, this technical writing approach supports migration notes and version transitions by generating dedicated migration guides that provide structured documentation to help developers smoothly navigate API version changes.

Can I generate conceptual guides that explain how an API works?▼

Yes, you can generate conceptual guides that explain what an API or system is, why it matters, and how it works, providing the foundational context developers need alongside standard API reference materials.

Related Skills

Explore More Content & Communication Skills→
EsellersEGEsellersEG

shopify-dev

Search Shopify developer documentation for API definitions and implementation examples.

Community
Intermediate
AbsolutelySkilledAbsolutelySkilled
207

developer-experience

Streamline SDK design, onboarding flows, and migration documentation for engineering teams.

Official
Advanced
spideynolovespideynolove
2

api-documentation-generator

Generate OpenAPI specs and endpoint documentation from source code.

Community
Advanced
davpatel605-beepdavpatel605-beep

code-wiki

Generate structured wiki documentation and Mermaid architecture diagrams from source code.

Community
Advanced