api-doc-authoring
Write API docs around a developer use case, with executed examples and failure recovery. Use when you say document this API or write the API guide. Do NOT use to verify doc claims (use doc-accuracy) or design the API.
- License
- MIT
Pinned to revision acff1d0a1f21, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/api-doc-authoring/SKILL.md
- skills/api-doc-authoring/references/example-verification.md
- skills/api-doc-authoring/references/use-case-flow.md
- skills/api-doc-authoring/references/worked-example.md
- skills/api-doc-authoring/scripts/api_examples.py
- skills/api-doc-authoring/scripts/doc_examples.py
Every link opens the file at its source, pinned to the revision this page describes.