Choose a model for the work you need to doMe
← Use casesProduct & engineering

Technical documentation & developer support

Build documentation and runnable examples from code and verified APIs, answer developer questions using retrieved evidence, and track documentation impacts of code changes.

What to prepare

Inputs

Code, API specifications, examples, common errors, and product version.

What to produce

Deliverables

API documentation, runnable examples, troubleshooting guides, and cited support answers.

Step-by-step workflow

Break the work into verifiable stages, then choose models and supporting tools.

  1. 01

    Align API facts

    Check actual routes, parameters, permissions, return values, and error messages.

  2. 02

    Generate and run examples

    Write examples with model assistance and run them in a test account and environment before documenting them.

  3. 03

    Build troubleshooting paths

    Derive diagnostic steps from real issues, recording versions and applicable conditions.

  4. 04

    Maintain retrieval and updates

    Index documentation and check affected sections and examples after code changes.

Required model capabilities

Combine models for the actual stages. The directory includes candidates matching one or more of these capabilities.

View matching models

Supporting tools

API test environmentCode & documentation searchVector knowledge base

Selection & delivery checks

  • Generated API names must match implementation or official documentation.
  • Passing a syntax check does not prove an API call succeeded.
  • Retain versions and sources in support answers; do not invent undocumented parameters.

An example request

Write and test examples against actual APIs, index documentation with embeddings, and produce developer support answers with sources and version context.
Find models for this request

Related scenarios

All scenarios