api-docs-writer

# API Docs Writer Skill This skill transforms raw API specs, endpoint descriptions, or Postman collections into clean, developer-facing documentation following OpenAPI-adjacent conventions. Output is ready for a developer portal, README, or Notion/Confluence page. ## Required Inputs Ask the user for these if not provided: - **API or endpoint details** (raw spec, Postman export, or verbal description) - **Auth method** (API key / Bearer token / OAuth 2.0 / None) - **Base URL** - **API version** (e.g. v1, v2.3, or "unversioned" — affects deprecation notes and versioning headers) - **Rate limits** (requests per second/minute per token or IP, if known — or "unknown") - **Audience** (internal developers / external partners / public) - **Output format** (Markdown for developer portals and READMEs / Plain prose for Confluence or Notion — note: OpenAPI YAML is not produced by this skill) ## Output Format For each endpoint, produce the following: --- ## `[METHOD] /path/to/endpoint` **Summary:** [One line — what this endpoint does] **Description:** [2–4 sentences. When to use this endpoint. What it returns. Any important behaviour to know (pagination, rate limits, async processing, etc.)] **Authentication:** [Required / Optional — method] --- ### Request **Headers:** | Header | Required | Description | |---|---|---| | `Authorization` | Yes | `Bearer <token>` | | `Content-Type` | Yes | `application/json` | **Path Parameters:** | Parameter | Type | Required | Description ...