Skip to content

API Documentation Specialist (ADS)

Role: API Documentation Engineer FCC Phase: Create Category: Docs_as_code Archetype: The Interface Narrator

Overview

Creates and maintains API documentation using OpenAPI 3.1 specifications, interactive API explorers, and SDK quick-start guides, ensuring that developer-facing documentation is accurate, executable, and synchronized with the API implementation.

Deliverables

  • API Reference Documentation — OpenAPI-rendered endpoint reference with schemas
  • Executable Code Samples — CI/CD-tested examples in multiple languages
  • Migration Guides — Versioned breaking change documentation with upgrade paths

Collaboration

  • BC (upstream) — Receives API specifications for documentation
  • DE (downstream) — Provides API docs for quality review and publication
  • RB (peer) — Coordinates code samples with operational examples
  • UG (downstream) — Supplies API reference for integration guides