technical-writer-api-docs

Community

Produce exact API reference docs from specs.

Authorlookatitude
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Documents an existing API contract into precise reference pages per endpoint, mirroring the source specification and preventing drift.

Core Features & Use Cases

  • Mirrors the contract exactly (OpenAPI/SDL/code) for every endpoint.
  • Includes authentication, pagination, error tables, and versioning notes.
  • Use Case: deliver developer-ready reference docs that map 1:1 to the contract, enabling curl/SDK examples without guessing.

Quick Start

Provide the API contract (OpenAPI/SDL) and let this skill generate reference pages for the requested endpoints.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: technical-writer-api-docs
Download link: https://github.com/lookatitude/guild/archive/main.zip#technical-writer-api-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.