api-docs-writer

Writes precise, complete reference documentation for HTTP/REST APIs and authors valid OpenAPI 3.1 specifications, including endpoint pages, request/response schemas, parameter tables, authentication, pagination, code samples, and error tables. Use this skill when the user asks to "document an API", "write API reference docs", "create an OpenAPI/Swagger spec", "document these endpoints", "write a REST API...

Publisher type
Community
Repository
JayRHa/AgentSkills
Skill
api-docs-writer
GitHub repository stars
5
npx skills add https://github.com/JayRHa/AgentSkills --skill api-docs-writer

Agent skills can contain instructions that call tools or modify files. Review the source and permissions before installation.

What this resource does

api-docs-writer is a reusable AI-agent instruction package published by JayRHa. It gives a compatible agent a repeatable procedure for work in this area: Founder workflows.

Best for

  • Founders and teams using an AI coding or work agent for tasks in this area: Founder workflows.
  • Repeatable work that matches this capability: Writes precise, complete reference documentation for HTTP/REST APIs and authors valid OpenAPI 3.1 specifications, including endpoint pages, request/response schemas, parameter tables, authentication, pagination, code samples, and error tables. Use this skill when the user asks to "document an API", "write API reference docs", "create an OpenAPI/Swagger spec", "document these endpoints", "write a REST API...
  • Users who want a publisher-defined workflow they can inspect before running.

What to prepare

  • A compatible AI agent that supports Agent Skills.
  • Access to the project or files the task will use.
  • Any provider accounts, command-line tools, or credentials requested by the skill.
  • A safe branch or backup when the skill may modify files.

How to use it

  1. Open the original repository and review SKILL.md, referenced files, scripts, and requested permissions.
  2. Copy the install command and run it from the workspace where you want to use api-docs-writer.
  3. Reload or restart the agent if it does not discover the new skill immediately.
  4. Give the agent a concrete task in this area: Founder workflows. Explicitly name api-docs-writer when you want to require its use.
  5. Review the proposed actions and output before approving file changes, shell commands, credentials, or external writes.

Example request

Use the api-docs-writer skill for this task. First inspect the available context, explain the proposed approach, and wait for approval before any sensitive or destructive action.

Before you continue: Publisher category: Community. Publication in this catalog is not a security guarantee. Review the current repository before installation.

Source and review

Source check: 2026-09-05.

JayRHa