documentation

Generate API documentation by producing endpoint references that include authentication details, request/response examples, pagination info, and SDK usage. This API documentation targets engineering teams and provides clear operational context for integration.

Write a runbook by creating step-by-step operational procedures with prerequisites, rollback steps, and escalation paths. A runbook ensures operations teams have clear instructions for handling common failures and incidents.

Create an onboarding guide by documenting high-level architecture context, key decisions, and developer onboarding tasks. An onboarding guide accelerates team integration by providing targeted quick-starts and clear resource linking.

Yes, you can craft a focused README that explains purpose, provides a under five minute quick start, and links to deeper resources. The README includes curl examples and short runbooks for common service failures.

Technical documentation for maintenance workflows should include decision rationale, rollback steps, and audience-targeted operational procedures. This ensures engineering, product, and operations teams can maintain and operate systems effectively.

Yes, this approach works for both architecture docs and API references by producing audience-focused content. It documents high-level context and decisions for architecture, alongside endpoint references and examples for API documentation.