Create technical documentation
Generate README, architecture and runbook content derived from the code, with citations.
Beginner30 minCOMMUNITY ANALYSISMarkdownMermaid
Prompt
Write technical documentation for this service. Sections: overview, architecture with a Mermaid diagram, configuration reference extracted from actual environment variables, local setup, deployment, runbook for the three most likely failure modes. Cite a file path for every factual claim. Mark anything you inferred as an assumption.
Problem
Documentation drifts from the code within a quarter.
Goal
Docs that can be regenerated and reviewed like code.
Context
Any service repository being handed to another team.
Expected Output
README, architecture page with Mermaid diagram, runbook draft.
Steps
- Run from the repository root
- Verify every citation
- Follow the setup steps on a clean machine
- Commit docs in-repo
Validation
- Clean-machine setup run
- Citation spot check
Security Considerations
- Strip internal hostnames and credentials before publishing externally
Lessons Learned
- Citations turn review into verification
- Runbooks still need someone who has handled the incident
Related prompts