API Doc Writing

Core Workflow

1. Identify the API audience, surface area, source of truth, auth model, and version.
2. Read code, specs, tests, schemas, or examples before documenting behavior.
3. Document each operation with purpose, inputs, outputs, auth, errors, limits, side effects, and examples.
4. Separate stable contract from implementation detail.
5. Flag unknown behavior, undocumented errors, missing examples, and version mismatches.
6. Include validation or review steps for generated docs.

Safety Rules