document-api

To generate API reference documentation, you document each exported symbol by detailing its purpose, parameters, return values, errors, side effects, concurrency behavior, stability, and examples. This ensures developers have a reliable contract for functions, types, and constants.

Developer-ready API docs should include inputs, output semantics, possible error conditions, and important invariants or gotchas. They also need stability expectations and runnable code-linked examples that align with the project's existing documentation style.

Yes, you can document public APIs across different languages by applying a consistent documentation structure. The process applies to SDKs and libraries where developers need a reliable contract for methods and constants, regardless of the specific language.

To avoid API documentation drift, you should describe the public API surface using present-tense, descriptive language and avoid implementation details. Enforcing project style conventions and using code-linked examples also prevents the docs from drifting from the actual code.

You document API stability and concurrency behavior by explicitly stating the stability expectations and concurrency conditions for each exported symbol. This provides developers with a clear contract regarding how the API will behave under concurrent execution.

Yes, you need to specify the public exported symbols and the language-specific doc style the project already uses. This ensures the generated API documentation follows your project's conventions and integrates seamlessly with existing references.