api-documenter
Create Accurate API Documentation
Incomplete API documentation slows integrations and increases support demand. This skill structures specifications, examples, portals, SDK guidance, validation, and migration content for developer audiences.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "api-documenter" from https://skillstore.io/skills/sickn33-api-documenter.md and its manifest at https://skillstore.io/api/skills/sickn33-api-documenter/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "api-documenter". Document the customer lookup endpoint for partner developers.
Expected outcome:
- Purpose: Retrieves one customer record by its stable identifier.
- Authentication: Requires a partner access token with customer read permission.
- Errors: Explains invalid identifiers, missing records, expired tokens, and rate limits.
Using "api-documenter". Review our payment API documentation for onboarding gaps.
Expected outcome:
- Add a first payment tutorial with prerequisites and expected results.
- Provide test credentials, idempotency guidance, and a complete error reference.
- Link webhook verification steps from every asynchronous payment flow.
Using "api-documenter". Outline a migration guide from API version one to version two.
Expected outcome:
The guide separates breaking changes, replacement fields, updated authentication, migration steps, validation checks, rollback guidance, and the deprecation timeline.
Security Audit
SafeAll three static findings are false positives caused by ordinary documentation language. The skill contains guidance only, with no network reconnaissance instructions, executable code, or prompt injection.
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/sickn33-api-documenter/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-documenter/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/sickn33-api-documenter.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
sickn33. (2026). api-documenter security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-documenter/audits/5BibTeX citation
@techreport{sickn33-sickn33-api-documenter-2026,
author = {sickn33},
title = {api-documenter security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-api-documenter/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-documenter security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-api-documenter/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-api-documenter:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Publish a REST API Reference
Turn endpoint requirements into a structured OpenAPI specification with authentication, request, response, and error guidance.
Design a Developer Portal
Plan navigation, onboarding, search, tutorials, interactive exploration, analytics, and support paths across multiple APIs.
Prepare a Version Migration
Explain breaking changes, compatibility concerns, upgrade steps, deprecation dates, and validation checks for existing integrations.
Try These Prompts
Document this endpoint for new integrators: [endpoint details]. Include its purpose, authentication, parameters, responses, errors, and one realistic example.
Review this OpenAPI specification: [specification]. Identify missing schemas, unclear descriptions, incomplete examples, authentication gaps, and inconsistent error responses.
Design a developer portal for [APIs] and [audiences]. Provide information architecture, onboarding journeys, search needs, interactive tools, governance, and success measures.
Create a documentation delivery strategy for [API program]. Cover contracts, SDK generation, example tests, deployment gates, versioning, migrations, analytics, ownership, and review cadence.
Best Practices
- Confirm every documented behavior against the current specification, implementation, or tested response.
- Use realistic examples that show authentication, successful responses, common errors, and recovery steps.
- Assign ownership and automate validation so documentation changes remain synchronized with API releases.
Avoid
- Do not invent endpoints, fields, credentials, or response behavior when source details are missing.
- Do not publish generated examples without testing them against an approved environment.
- Do not hide breaking changes inside general release notes without a dedicated migration path.