Skip to content
Skills Library
Programming · Writing

api-documentation

/api-documentation

Document an existing or proposed HTTP API for its actual consumers. Use when creating API reference docs, examples, authentication guidance, or migration notes.

Repository
skillsmo ↗
Licence
MIT
Last repository change
12.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
3
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 12.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Document an existing or proposed HTTP API for its actual consumers. Use when creating API reference docs, examples, authentication guidance, or migration notes.

Original author description

Document an existing or proposed HTTP API for its actual consumers. Use when creating API reference docs, examples, authentication guidance, or migration notes.

How it works

  1. Goal
  2. Workflow
  3. Decision rules
  4. Boundaries
  5. Completion standard
  6. Further reading
Original SKILL.md headings · 35 lines, 230 words
SKILL.md preview
---
name: api-documentation
description: "Document an existing or proposed HTTP API for its actual consumers. Use when creating API reference docs, examples, authentication guidance, or migration notes."
---

# API documentation

## Goal

Make an API understandable without inventing behavior or exposing private implementation details.

## Workflow

1. Inspect the current OpenAPI document, handlers, tests, authentication model, and versioned conventions.
2. Document purpose, parameters, request/response schemas, auth requirements, status codes, error format, pagination, and rate limits when known.
3. Add minimal examples that match observed schemas and avoid real credentials or personal data.
4. Explain compatibility, deprecation, idempotency, and retry behavior where consumers need them.
5. Check every example against the contract and link to stable concepts instead of duplicating volatile details.

## Decision rules

- Use the OpenAPI document as the source of structured reference where it is authoritative.
- Separate confirmed behavior from recommendations or unverified limits.
- Write for the consumer's task rather than the server's code structure.

## Boundaries

- Do not promise undocumented guarantees or invent rate limits.
- Never publish secrets, internal hostnames, private customer data, or unsafe example credentials.

## Completion standard

Return the requested artifact or findings with enough evidence for a reviewer to understand what changed, what was checked, and what remains uncertain. Distinguish observed facts, inferred risks, and unverified assumptions. Keep the scope tied to the user's request.

## Further reading

- [Field guide](references/field-guide.md) — use for task-specific review questions and edge cases.
- [Source and rights notes](references/source-notes.md) — use when maintaining this package or reviewing its provenance.
Files in this package (3)
  • SKILL.md 2 KB
  • references/field-guide.md 1 KB
  • references/source-notes.md 1 KB

Versions

RepositoryScoreLicence
This page · helx0071/skillsmo100MIT
akillness/jeo-skills100MIT
OKHP3/skillz100MIT
drvoss/everything-copilot-cli100MIT
postmanlabs/postman-plugin100Apache-2.0
LambdaTest/agent-skills100MIT
autohandai/community-skills100Apache-2.0
zircote-plugins/documentation-review100MIT
j4flmao/agent-skills95MIT

Database snapshot: 13.11.2026 · package version ec47354c3077 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100docs-and-examples
    Use when writing or updating README content, API examples, installation instructions, migration notes, or developer-facing documentation for a TypeScript library.
  • 100api-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…
  • 100generating-api-docs
    Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API".
  • 100generating-api-docs
    Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API".
  • 90api-contracts
    Design or change an HTTP API contract for new or existing consumers. Use when endpoints, schemas, errors, authentication, versioning, or compatibility are changing.
  • 100api-docs
    Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.