Documentation

Write and maintain technical docs: READMEs, runbooks, API docs, architecture guides.

documentation readme api-docs runbooks

When to use

Trigger with 'write docs for', 'document this', 'create a README', 'write a runbook', 'onboarding guide', or when needing any form of technical writing. Produces API docs, architecture docs, operational runbooks, and developer guides.

Examples

Write a README

Generate a comprehensive README for a project or library

Write a README for our open-source CLI tool. It's a Node.js tool for syncing Figma tokens to CSS variables.

Create a runbook

Document operational procedures for on-call engineers

Write a runbook for restarting our worker queue when it backs up. Include health checks and escalation steps.

Document an API

Generate API reference docs from code or a spec

Document our REST API for the /orders endpoint. Here's the Express router code: ...