Documentation21 categories
What is this README missing?
Before publishing a README you wrote in one sitting.
What is missing from this README that a first-time user will need? List the gaps, do not fill them yet.
Making it yours
- Paste your own material where the prompt asks for it. Everything above that line is instruction, not content.
- Delete any rule that does not apply to you. A shorter prompt that fits beats a thorough one that does not.
- If the answer comes back vague, add a line saying what you do not want. Constraints work better than encouragement.
Getting someone started. READMEs, setup guides, onboarding and glossaries for the person meeting this for the first time.
Related prompts
Structure a README that gets someone runningA project with working code and a README that says only its name.Write a getting-started guide that ends in a winNew users install the thing and then don't know what to do next.Build a glossary for this domainNew starters keep asking what a word means and getting three answers.Write onboarding docs for a new teammateSomeone starts Monday and the setup knowledge lives in three people's heads.One-line descriptionThe first sentence of a README, or a repo description field.Summarise this for a newcomerSomeone joins next week and this is the thing they'll meet first.
Keep this one
Phrasery saves prompts with a right-click and puts them back the same way. Add this to your own library in one click.
Add to your browser — free