api-documentation-writer SKILL.md skillA
api-documentation-writer from onewave-ai/claude-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add onewave-ai/claude-skills/api-documentation-writer@git:20260608.d82d20fPins git:20260608.d82d20f in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- onewave-ai/claude-skills
- Path
api-documentation-writer/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260608.d82d20f, committed Jun 8, 2026
- First version recorded
- Oct 22, 2025
- Size
- 2,168 bytes
- Repository stars
- 358
- License
- MIT
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API Documentation Writer Generate comprehensive, developer-friendly API documentation. ## Contents - `references/documentation-structure.md` — every section to cover (overview, auth, endpoints, errors, rate limits, SDKs, webhooks, GraphQL) - `references/output-template.md` — canonical REST Markdown template with worked examples - `references/best-practices.md` — best practices, developer-experience tips, and the output quality checklist ## Workflow 1. Gather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and versioning strategy, available endpoints and their purposes, request/response formats, and any rate limiting or usage restrictions. 2. Build the documentation structure. Cover every section in `references/documentation-structure.md`, ordering the most common operations first. 3. Generate the output. Follow `references/output-template.md` for REST APIs; adapt to schema, query, mutation, and subscription examples for GraphQL. Replace all placeholders with realistic example data and show both request and response. …
Read the whole file at its exact version.
How to install
mdr add onewave-ai/claude-skills/api-documentation-writer@sha256:c3944495f280cb17The line at the top of this page pins the label git:20260608.d82d20f, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_fbf26jzhmkdtwzzt)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Oct 22, 2025 and Jun 8, 2026, about one every 228 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260608.d82d20f latest | 2026-06-08 | d82d20f | 2,168 B | A | view · diff |
| git:20251022.14b7f5b | 2025-10-22 | 14b7f5b | 7,424 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (2168 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
onewave-ai/claude-skills · 358 stars · license MIT · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_fbf26jzhmkdtwzzt GET https://markdownregistry.com/api/v1/resolve?ref=onewave-ai/claude-skills/api-documentation-writer GET https://markdownregistry.com/api/v1/blob/c3944495f280cb17a434fa07eadba749d1630e5d578d2efcc4177e5a3c103098
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.