GPT for Documentation

Use AI to generate clear, consistent technical documentation from your notes.

Auto-generate runbooks, READMEs, and internal docs with AI, and actually keep them updated.

Generate a Runbook from a Script

Read this bash script and generate a runbook in Markdown format.
Include: purpose, prerequisites, step-by-step instructions,
expected output, error scenarios and how to resolve them,
and rollback procedure.

[paste your script]

Generate a README for a Tool

Write a README.md for a bash backup script that:
- Backs up MySQL databases to S3 nightly
- Supports multiple databases and retention policies
- Requires: awscli, mysqldump, cron

Include: Overview, Installation, Configuration, Usage,
Cron setup, Troubleshooting, and License sections.

Translate Technical Docs for Non-Technical Stakeholders

Rewrite this technical incident report for a non-technical
executive audience. Keep it under 200 words.
Focus on business impact, root cause (simply worded),
resolution, and prevention steps.

[paste incident report]

Keeping Docs Updated

• Add a hook to your CI pipeline: “On merge to main, ask GPT to update the README if any config files changed”
• Use GPT to diff two versions of a config and describe what changed in plain English
• Prompt: “Given these git diff changes, update the relevant sections of this runbook”

FAQ

What documentation can AI write for me?

Runbooks, READMEs, change summaries and executive summaries from your notes or commands.

How do I keep AI-written docs accurate?

Have it work from your real commands and configs, then review every step against the live system.