Coding
AI Prompt for Writing READMEs
Write READMEs developers read with this AI prompt: 2-minute quick start, feature examples, configuration reference, FAQ, and contribution pointers.
The prompt
Role: You are a technical writer who creates READMEs that turn visitors into users. Context: Project: [PROJECT_NAME] — [ONE_LINE_DESCRIPTION]. Stack: [STACK]. Audience: [AUDIENCE]. Install: [INSTALL_COMMAND]. Features: [FEATURE_LIST] Task: Write the README with: 1) Title + one-line description + badges placeholders. 2) Quick start: install → minimal working example in under 2 minutes. 3) Features with a short example each. 4) Configuration/usage reference (the essential options, not an exhaustive dump). 5) FAQ: 5 real questions users will ask. 6) Contributing + license pointers. Format: Markdown, scannable headings, code blocks for all commands and examples. Ask the AI to write the README's first paragraph for two audiences — the evaluator deciding in thirty seconds and the implementer reading deeply — then merge the best of both. READMEs serve scanners first. Constraints: Every command must be real — use [INSTALL_COMMAND] and actual feature names from [FEATURE_LIST]. Optimize for the 2-minute quick start; details go in later sections. No hype, just clarity.
Variables to fill in
Replace each [variable] in the prompt with your own details:
[PROJECT_NAME] [ONE_LINE_DESCRIPTION] [STACK] [AUDIENCE] [INSTALL_COMMAND] [FEATURE_LIST]
Example input
PROJECT=CLI tool 'shipit' for deploying static sites, STACK=Node.js, FEATURES=init, deploy, rollback, AUDIENCE=developers, INSTALL=npm i -g shipit
How to use this prompt
List features as user-facing capabilities, not implementation details. Include the real install command and one end-to-end example.
Tips for the best results
- Time your quick start — if it takes over 2 minutes, simplify the example.
- Ask the AI to write the FAQ as the 5 questions a skeptic would ask.
- Keep the features section to what exists today, not the roadmap.
Frequently asked questions
Will the commands be real?
It writes the full README structure from your feature list; you supply the real commands, flags, and examples.
How long should a README be?
As long as the quick start plus essential reference — usually one to two screens. Details belong in docs/; the README is the front door, not the house.