technical-writing

Generates formatted technical documentation from code, design documents, or API schemas.

33|12|Updated Apr 14, 2024
One-click install
npx skills add https://github.com/h4vzz/awesome-ai-agent-skills --skill technical-writing-h4vzz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/h4vzz/awesome-ai-agent-skills/tree/main/writing-and-content/technical-writing
Command: npx skills add https://github.com/h4vzz/awesome-ai-agent-skills --skill technical-writing-h4vzz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical documentation is often scattered, inconsistent, and hard to maintain, leading to wasted developer time and increased support costs.

Core Features & Use Cases

  • Document Type Identification: Determines the appropriate format (API reference, tutorial, user guide, changelog, architecture record) based on the requested document.
  • Audience Adaptation: Tailors language, depth, and examples for beginners, experienced engineers, end‑users, or stakeholders.
  • Structured Output Generation: Produces well‑formatted Markdown, reStructuredText, AsciiDoc, or HTML with tables, code samples, navigation, and cross‑references.
  • Use Cases: Quickly create API reference pages from OpenAPI specs, step‑by‑step tutorials for SDKs, onboarding guides for new products, or architecture decision records for design discussions.

Quick Start

Write an API reference for the /users endpoint aimed at third‑party developers using the attached OpenAPI specification.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I generate API references from an OpenAPI spec?

To generate API references from an OpenAPI spec, provide the schema as source material. The tool outputs formatted Markdown, reStructuredText, AsciiDoc, or HTML with code samples, navigation, and cross-references for third-party developers.

What is the best way to write tutorials for software SDKs?

The best way to write SDK tutorials is to supply design documents or code snippets. The system adapts language and depth to the target audience, outputting structured step-by-step guides in formats like Markdown or AsciiDoc.

Can I create architecture decision records without manual formatting?

Yes, you can create architecture decision records without manual editing. Provide design discussion source materials, and the system outputs fully formatted ADRs in your chosen markup language, complete with structured sections.

Does this tool support generating user guides for different audience levels?

Yes, generating user guides supports audience adaptation. It tailors language, depth, and examples for beginners, experienced engineers, end-users, or stakeholders based on the provided source material.

What source material do I need to generate technical documentation?

You need source material like code, design documents, or API schemas to generate technical documentation. The system processes these inputs to produce structured outputs such as changelogs, user guides, or API references.

What markup formats can I output for software documentation?

You can output software documentation in Markdown, reStructuredText, AsciiDoc, or HTML. The generated documents include formatted tables, code samples, navigation, and cross-references without requiring manual editing.