From pm-engineering
Transforms raw API specs, endpoint descriptions, or Postman collections into clean developer-facing documentation with endpoint summaries, parameters, request/response examples, and error codes.
How this skill is triggered — by the user, by Claude, or both
Slash command
/pm-engineering:api-docs-writerThe summary Claude sees in its skill listing — used to decide when to auto-load this 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.
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.
Ask the user for these if not provided:
For each endpoint, produce the following:
[METHOD] /path/to/endpointSummary: [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]
Headers:
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <token> |
Content-Type | Yes | application/json |
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier for the resource |
Query Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 20 | Max results per page (1–100) |
cursor | string | No | — | Pagination cursor from previous response |
Request Body:
{
"field_name": "value",
"another_field": 42
}
| Field | Type | Required | Description |
|---|---|---|---|
field_name | string | Yes | [Plain description of what this field does] |
another_field | integer | No | [Description. Include valid range or enum values if applicable] |
Success Response: 200 OK
{
"id": "abc123",
"status": "active",
"created_at": "2025-04-01T10:00:00Z"
}
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the created/retrieved resource |
status | string | Current status. Enum: active, inactive, pending |
created_at | ISO 8601 string | Timestamp of creation in UTC |
| Status Code | Error Code | Description | How to Resolve |
|---|---|---|---|
400 | INVALID_REQUEST | Request body is malformed or missing required fields | Check request body against schema above |
401 | UNAUTHORIZED | Missing or invalid authentication token | Verify your API key or refresh your token |
404 | NOT_FOUND | The requested resource does not exist | Check the ID in the path parameter |
429 | RATE_LIMITED | Too many requests | Back off and retry after Retry-After header value |
500 | INTERNAL_ERROR | Unexpected server error | Retry with exponential backoff; contact support if persists |
Produce examples in at least 2 languages relevant to the audience (default: cURL + Python):
cURL:
curl -X POST https://api.example.com/v1/endpoint \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"field_name": "value"}'
Python:
import requests
response = requests.post(
"https://api.example.com/v1/endpoint",
headers={"Authorization": "Bearer YOUR_TOKEN"},
json={"field_name": "value"}
)
data = response.json()
npx claudepluginhub mohitagw15856/pm-claude-skills --plugin pm-engineeringGuides writing developer-friendly API reference documentation, endpoint descriptions, and SDK docs using OpenAPI 3.1 standards and best practices from Stripe/Google.
Generates API documentation from codebases, including endpoints, parameters, examples, auth, errors, and OpenAPI specs for REST, GraphQL, and WebSocket APIs. Use for new APIs, updates, or onboarding.
Creates professional API documentation from OpenAPI specs with endpoints, authentication, and interactive examples. Use for documenting REST APIs, SDK references, or developer portals.