All questions
What should prompt documentation include?
Include purpose, owner, inputs, outputs, dependencies (tools/retrieval), acceptance criteria, examples, and known failure modes. Record evaluation metrics, last review date, and change history. Keep docs short and current—they should help someone fix an issue in minutes.
In practice
Add a ‘first-aid’ section: what to check when outputs go wrong.
Where to start
- 1Adopt a standard prompt header template.
- 2Backfill docs for your top 10 prompts.
- 3Link each prompt to its eval dashboard.
- 4Review docs quarterly for accuracy.
prompt documentationprompt READMEdocumenting prompts