Write a README config table from the code, not the old docs

About this exercise

The README's config section is out of date. Write a replacement: the heading '## Configuration', then a markdown table with exactly the columns Variable | Required | Default | Purpose, one row per environment variable the code actually reads. Use yes or no for Required and - when there's no default, and keep each Purpose under 8 words. Nothing after the table, no code blocks, under 110 words.

Common mistakes when you ask AI for this

• Trusting the old README. The README and .env.example still say 3000 and list REDIS_URL, and the AI copies them. Try: Add: "Use only what app/config.py reads, with its defaults."
• No fixed shape. The AI writes bullets, prose or its own table columns. Try: Give it: "## Configuration, then a table with columns Variable | Required | Default | Purpose."
• A whole new README. Asked to update the README, the AI rewrites every section, with code blocks. Try: Add: "Only this section; nothing after the table; no code blocks."

What a strong prompt includes

• Says to trust the code
• Gives the heading
• Gives the table columns
• Mentions the removed variable
• Limits the section

Practice this now ↑

Related exercises

• Accept a job offer and confirm the exact terms (Writing AI · Job seekers)
• Add a cron line that matches the others in a crontab (Coding AI · Product managers)
• Add dark mode by overriding your existing CSS variables (Coding AI · Software developers)
• Add input checks to your number guessing game (Coding AI · High school students)
• Add input validation to a Java method with exact messages (Coding AI · Software developers)