Documentation21 categories
Write an architecture decision record
A decision was made in a meeting and will be questioned in a year.
Write an architecture decision record for the decision below. Sections: - **Status**: proposed, accepted, or superseded, with a date - **Context**: the forces at play, written so a reader in two years understands the situation without asking anyone. Include constraints that were real at the time: team size, deadline, existing systems - **Decision**: what we are doing, in the active voice, in one paragraph - **Alternatives considered**: each with why it was rejected. Give each a fair account. If an alternative was rejected for a non-technical reason, say that honestly - **Consequences**: what becomes easier, what becomes harder, what we are now committed to, what we will have to revisit - **Revisit when**: the specific condition that should make someone reopen this Do not write it as a justification. A future reader should be able to disagree with it on the evidence given. Decision:
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.Changelog line for this changeOne commit that needs one honest user-facing line.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