Documentation21 categories
Changelog line for this change
One commit that needs one honest user-facing line.
Mediumchangelogrelease
Turn this change into a single changelog line written for a user, plus a before-and-after snippet if the call site changes. Describe the effect, not the implementation. If nothing a user can observe changed, tell me that instead of writing an entry. Change:
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.
Releases and decisions. Changelogs, migration guides and decision records that explain what changed and why.
Related prompts
Write changelog entries from these commitsCutting a release and the commit log is not a changelog.Write a migration guide for a breaking changeShipping a major version and users have to change their code.Write an architecture decision recordA decision was made in a meeting and will be questioned in a year.Structure a README that gets someone runningA project with working code and a README that says only its name.Generate API reference from this codeA module whose public surface needs documenting properly, not just typed.Write the doc comment this function deservesA function whose name and types don't tell the whole story.
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