Documentation21 categories
Build a glossary for this domain
New starters keep asking what a word means and getting three answers.
Build a glossary from the material below. For each term: - A one-sentence definition a newcomer understands without following a link - A second sentence only if the term is easily confused with another. Name the other and give the distinction - Where it appears in our system: the table, the service, the UI label - Any term used differently here than in the wider industry, flagged explicitly Also produce two lists: 1. **Collisions**: terms used for more than one thing, or several terms used for the same thing. Recommend which usage wins. 2. **Undefined**: terms that appear in the material without ever being defined anywhere. Define terms in dependency order where one definition needs another, but do not create chains longer than two. Material (docs, code, tickets, or a transcript):
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.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.What is this README missing?Before publishing a README you wrote in one sitting.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