Awesome-omni-skills api-documentation

API Documentation Workflow workflow skill. Use this skill when the user needs API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation and the operator should preserve the upstream workflow, copied support files, and provenance before merging or handing off.

install

source · Clone the upstream repo

git clone https://github.com/diegosouzapw/awesome-omni-skills

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/api-documentation" ~/.claude/skills/diegosouzapw-awesome-omni-skills-api-documentation && rm -rf "$T"

manifest: skills/api-documentation/SKILL.md

API Documentation Workflow

Overview

This public intake copy packages

plugins/antigravity-awesome-skills-claude/skills/api-documentation

from

https://github.com/sickn33/antigravity-awesome-skills

into the native Omni Skills editorial shape without hiding its origin.

Use it when the operator needs the upstream workflow, support files, and repository context to stay intact while the public validator and private enhancer continue their normal downstream flow.

This intake keeps the copied upstream files intact and uses

metadata.json

plus

ORIGIN.md

as the provenance anchor for review.

API Documentation Workflow

Imported source sections that did not map cleanly to the public headings are still preserved below or in the support files. Notable imported sections: Quality Gates, Limitations.

When to Use This Skill

Use this section as the trigger filter. It should make the activation boundary explicit before the operator loads files, runs commands, or opens a pull request.

Creating API documentation
Generating OpenAPI specs
Writing developer guides
Adding code examples
Setting up API portals
Use when the request clearly matches the imported source intent: API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.

Operating Table

Situation	Start here	Why it matters
First-time use	`metadata.json`	Confirms repository, branch, commit, and imported path before touching the copied workflow
Provenance review	`ORIGIN.md`	Gives reviewers a plain-language audit trail for the imported source
Workflow execution	`SKILL.md`	Starts with the smallest copied file that materially changes execution
Supporting context	`SKILL.md`	Adds the next most relevant copied source file without loading the entire package
Handoff decision	`## Related Skills`	Helps the operator switch to a stronger native skill when the task drifts

Workflow

This workflow is intentionally editorial and operational at the same time. It keeps the imported source useful to the operator while still satisfying the public intake standards that feed the downstream enhancer flow.

api-documenter - API documentation
api-design-principles - API design
Inventory endpoints
Document request/response
Identify authentication
Map error codes
Note rate limits

Imported Workflow Notes

Imported: Workflow Phases

Phase 1: API Discovery

Skills to Invoke

```
api-documenter
```
- API documentation
```
api-design-principles
```
- API design

Actions

Inventory endpoints
Document request/response
Identify authentication
Map error codes
Note rate limits

Copy-Paste Prompts

Use @api-documenter to discover and document API endpoints

Phase 2: OpenAPI Specification

Skills to Invoke

```
openapi-spec-generation
```
- OpenAPI
```
api-documenter
```
- API specs

Actions

Create OpenAPI schema
Define paths
Add schemas
Configure security
Add examples

Copy-Paste Prompts

Use @openapi-spec-generation to create OpenAPI specification

Phase 3: Developer Guide

Skills to Invoke

```
api-documentation-generator
```
- Documentation
```
documentation-templates
```
- Templates

Actions

Create getting started
Write authentication guide
Document common patterns
Add troubleshooting
Create FAQ

Copy-Paste Prompts

Use @api-documentation-generator to create developer guide

Phase 4: Code Examples

Skills to Invoke

```
api-documenter
```
- Code examples
```
tutorial-engineer
```
- Tutorials

Actions

Create example requests
Write SDK examples
Add curl examples
Create tutorials
Test examples

Copy-Paste Prompts

Use @api-documenter to generate code examples

Phase 5: Interactive Docs

Skills to Invoke

```
api-documenter
```
- Interactive docs

Actions

Set up Swagger UI
Configure Redoc
Add try-it functionality
Test interactivity
Deploy docs

Copy-Paste Prompts

Use @api-documenter to set up interactive documentation

Phase 6: Documentation Site

Skills to Invoke

```
docs-architect
```
- Documentation architecture
```
wiki-page-writer
```
- Documentation

Actions

Choose platform
Design structure
Create pages
Add navigation
Configure search

Copy-Paste Prompts

Use @docs-architect to design API documentation site

Phase 7: Maintenance

Skills to Invoke

```
api-documenter
```
- Doc maintenance

Actions

Set up auto-generation
Configure validation
Add review process
Schedule updates
Monitor feedback

Copy-Paste Prompts

Use @api-documenter to set up automated doc generation

Imported: Related Workflow Bundles

```
documentation
```
- Documentation
```
api-development
```
- API development
```
development
```
- Development

Imported: Overview

Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.

Imported: Quality Gates

Examples

Example 1: Ask for the upstream workflow directly

Use @api-documentation to handle <task>. Start from the copied upstream workflow, load only the files that change the outcome, and keep provenance visible in the answer.

Explanation: This is the safest starting point when the operator needs the imported workflow, but not the entire repository.

Example 2: Ask for a provenance-grounded review

Review @api-documentation against metadata.json and ORIGIN.md, then explain which copied upstream files you would load first and why.

Explanation: Use this before review or troubleshooting when you need a precise, auditable explanation of origin and file selection.

Example 3: Narrow the copied support files before execution

Use @api-documentation for <task>. Load only the copied references, examples, or scripts that change the outcome, and name the files explicitly before proceeding.

Explanation: This keeps the skill aligned with progressive disclosure instead of loading the whole copied package by default.

Example 4: Build a reviewer packet

Review @api-documentation using the copied upstream files plus provenance, then summarize any gaps before merge.

Explanation: This is useful when the PR is waiting for human review and you want a repeatable audit packet.

Best Practices

Treat the generated public skill as a reviewable packaging layer around the upstream repository. The goal is to keep provenance explicit and load only the copied source material that materially improves execution.

Keep the imported skill grounded in the upstream repository; do not invent steps that the source material cannot support.
Prefer the smallest useful set of support files so the workflow stays auditable and fast to review.
Keep provenance, source commit, and imported file paths visible in notes and PR descriptions.
Point directly at the copied upstream files that justify the workflow instead of relying on generic review boilerplate.
Treat generated examples as scaffolding; adapt them to the concrete task before execution.
Route to a stronger native skill when architecture, debugging, design, or security concerns become dominant.

Troubleshooting

Problem: The operator skipped the imported context and answered too generically

Symptoms: The result ignores the upstream workflow in

plugins/antigravity-awesome-skills-claude/skills/api-documentation

, fails to mention provenance, or does not use any copied source files at all. Solution: Re-open

metadata.json

ORIGIN.md

, and the most relevant copied upstream files. Load only the files that materially change the answer, then restate the provenance before continuing.

Problem: The imported workflow feels incomplete during review

Symptoms: Reviewers can see the generated

SKILL.md

, but they cannot quickly tell which references, examples, or scripts matter for the current task. Solution: Point at the exact copied references, examples, scripts, or assets that justify the path you took. If the gap is still real, record it in the PR instead of hiding it.

Problem: The task drifted into a different specialization

Symptoms: The imported skill starts in the right place, but the work turns into debugging, architecture, design, security, or release orchestration that a native skill handles better. Solution: Use the related skills section to hand off deliberately. Keep the imported provenance visible so the next skill inherits the right context instead of starting blind.

Related Skills

```
@00-andruia-consultant
```
- Use when the work is better handled by that native specialization after this imported skill establishes context.
```
@10-andruia-skill-smith
```
- Use when the work is better handled by that native specialization after this imported skill establishes context.
```
@20-andruia-niche-intelligence
```
- Use when the work is better handled by that native specialization after this imported skill establishes context.
```
@3d-web-experience
```
- Use when the work is better handled by that native specialization after this imported skill establishes context.

Additional Resources

Use this support matrix and the linked files below as the operator packet for this imported skill. They should reflect real copied source material, not generic scaffolding.

Resource family	What it gives the reviewer	Example path
`references`	copied reference notes, guides, or background material from upstream	`references/n/a`
`examples`	worked examples or reusable prompts copied from upstream	`examples/n/a`
`scripts`	upstream helper scripts that change execution or validation	`scripts/n/a`
`agents`	routing or delegation notes that are genuinely part of the imported package	`agents/n/a`
`assets`	supporting assets or schemas copied from the source package	`assets/n/a`

Imported Reference Notes

Imported: Limitations

Use this skill only when the task clearly matches the scope described above.
Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.