api-docs-writer
Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a raw spec/Postman collection into documentation. Produces endpoint documentation with descriptions, parameters, request/response examples, and error codes.
npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# 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.)] **
- Required Inputs
- Output Format
- [METHOD] /path/to/endpoint
- Request
- Response
- Error Codes
- Code Examples
- Deeper Materials
- Scoring Rubric (0–40)
- Quality Checks
- Anti-Patterns
- Usage Examples
curl -X POST https://api.example.com/v1/endpoint \
What does the api-docs-writer skill do?
Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a raw spec/Postman collection into documentation. Produces endpoint documentation with descriptions, parameters, request/response examples, and error codes.
How do I install it?
Run `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From mohitagw15856/pm-claude-skills, a repository with 1,255 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.