API Documentation Specialist — Compare Workflow

Description: Evaluate multiple approaches or versions

When to Use

Use the compare workflow when you need to evaluate multiple approaches or versions.

Input Requirements

• OpenAPI 3.1 / AsyncAPI specification files
• API source code and automated documentation generation output
• Developer feedback and API support tickets
• SDK codegen configurations and client library documentation

Process

1. Initialize — Set up the compare context for API Documentation Specialist
2. Execute — Perform the compare operation following API Documentation Specialist's style
3. Validate — Check output against quality gates
4. Handoff — Deliver results to downstream personas

Output

• OpenAPI-rendered API reference documentation
• Executable code samples with language-specific SDK examples
• API getting-started guides and authentication tutorials
• API changelog and migration guides for breaking changes

Quality Gates

• API documentation must be generated from or validated against OpenAPI specs
• Code samples must be executable and tested in CI/CD pipelines
• Breaking changes must be documented with migration guides
• Documentation must be synchronized with API release versions