api-documentation
Create Complete API Documentation
Incomplete API documentation slows integration and increases support work. This skill organizes discovery, specifications, guides, examples, portals, and maintenance into one workflow.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "api-documentation" from https://skillstore.io/skills/sickn33-api-documentation.md and its manifest at https://skillstore.io/api/skills/sickn33-api-documentation/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-documentation". Plan documentation for a payments API with token authentication, refunds, webhooks, and rate limits.
Expected outcome:
Documentation plan: inventory payment and refund endpoints; define token security; document webhook verification; add errors, limits, examples, and release checks.
Using "api-documentation". Create the structure for an external developer guide.
Expected outcome:
- Getting started and credentials
- Authentication and request lifecycle
- Core workflows with tested examples
- Errors, rate limits, and troubleshooting
- Frequently asked questions and support
Using "api-documentation". Define maintenance checks for an existing API portal.
Expected outcome:
Maintenance checklist: validate specifications, test examples, review navigation, confirm deployment, assign owners, schedule updates, and monitor developer feedback.
Security Audit
SafeAll 28 static findings are false positives caused by Markdown inline-code markers and fenced prompt blocks. SKILL.md contains no executable shell commands, Ruby code, or prompt injection attempts.
Risk Factors
⚙️ External commands (28)
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-documentation/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/sickn33-api-documentation?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/sickn33-api-documentation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-documentation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/sickn33-api-documentation.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-documentation security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-documentation/audits/5BibTeX citation
@techreport{sickn33-sickn33-api-documentation-2026,
author = {sickn33},
title = {api-documentation security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-api-documentation/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-documentation 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-documentation/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-api-documentation:audit:5"
description: "Skillstore immutable audit report identifier"
Compare variants
3 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
supercent-io-api-documentation
2026-08-21
sickn33-api-documentation
2026-08-21
curiouslearner-api-documentation
2026-08-21
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Document a New Service
Create an endpoint inventory, OpenAPI plan, examples, and developer onboarding guide before release.
Standardize Documentation
Apply one repeatable structure and quality checklist across several APIs and documentation owners.
Build an API Portal
Plan interactive reference pages, navigation, search, deployment, validation, and ongoing maintenance.
Try These Prompts
Document this endpoint using its method, path, purpose, parameters, authentication, responses, errors, and rate limits: [endpoint details].
Create an OpenAPI documentation plan for [API]. Use this endpoint inventory, security model, schemas, errors, and examples: [details].
Design a developer guide for [audience] integrating with [API]. Include setup, authentication, common workflows, troubleshooting, examples, and frequently asked questions.
Design an end-to-end documentation program for [API portfolio]. Include discovery, OpenAPI governance, examples, portal architecture, validation, ownership, releases, and feedback.
Best Practices
- Provide endpoint source material, authentication rules, error behavior, and audience details before starting.
- Validate every specification and example against the running API.
- Assign documentation owners and update content during each API release.
Avoid
- Do not invent endpoints, schemas, credentials, responses, or rate limits.
- Do not publish generated examples without testing them in the target environment.
- Do not treat the initial documentation release as complete without maintenance ownership.