1.7 KiB
1.7 KiB
name, description, usage
| name | description | usage |
|---|---|---|
| update-api-reference | Generates API reference + guides updates from new schema changes with samples and changelog entries. | /technical-writing:update-api-reference --spec openapi.yaml --audience developers --outputs reference,guide --languages js,python |
Command: update-api-reference
Inputs
- spec – OpenAPI/AsyncAPI file path or URL.
- audience – developers | partners | internal | admins.
- outputs – reference, guide, changelog, tutorial (comma-separated).
- languages – code sample languages (js, python, curl, java, go, ruby, csharp).
- breaking-change – true/false toggle for migration guidance.
Workflow
- Spec Diff & Analysis – compare schema version vs prior baseline, note new/changed/deprecated endpoints.
- Content Scope – determine docs to update (reference tables, tutorials, SDK snippets, changelog entries).
- Drafting – produce updated endpoint descriptions, parameters, responses, usage notes, and code samples per language.
- Review Loop – route drafts to engineering/product for validation and to editorial for style compliance.
- Publishing & Versioning – push updates, tag version support, update changelog + migration guidance.
Outputs
- Updated API reference markdown/HTML with highlighted changes.
- Code sample bundle per requested languages.
- Changelog excerpt + migration guidance (if applicable).
Agent/Skill Invocations
api-docs-editor– leads spec diff + doc updates.documentation-architect– ensures IA + governance alignment.api-style-guideskill – enforces terminology, formatting, and code sample rules.versioning-dashboardskill – logs version info + deprecation timelines.