API Docs Writer

$1.99Official

Use when API reference docs must be generated or updated from source code, with verified schemas, runnable examples, and complete error catalogs.

productapidocumentationopenapireferencerestdeveloper-experienceยท by SkillingMain

What you get

  • โœ“9-step procedure
  • โœ“1 ready-to-run code block
  • โœ“8-point quality checklist
  • โœ“7 pitfalls to avoid
  • โœ“Installs into 6 tools
Version
v1 โ†’
Last updated
today
Length
5 min read
Requires
Works with any modern AI assistant

Works in: Claude Code, Codex, Cline, opencode, OpenClaw, Hermes

Preview

When to use

Use this skill when API reference documentation must be generated or updated from source code: REST or RPC handlers, GraphQL schemas, or a library's public surface. Trigger on requests like 'document this API', 'generate an API reference', 'write docs for these endpoints', or after endpoint changes land without doc updates.

Do not use for tutorials, conceptual guides, or README quickstarts โ€” those need narrative structure this skill does not produce. Reference entries built here can feed them afterwards.

Inputs to gather

  • Where the API surface lives: route files, controller directories, schema files, or the package entry point.
  • Target format: standalone markdown refe

โ€ฆ

๐Ÿ”’ Buy once ($1.99) to unlock the full playbook, download it, and install it in every tool you use.