Skip to content

DEV-160.md

Latest commit

 

History

History
38 lines (30 loc) · 1.26 KB

DEV-160.md

File metadata and controls

38 lines (30 loc) · 1.26 KB
Raw
id DEV-160
title Write a Clear Problem Statement
status active
enforcement manual
severity error
depends_on
DEV-150

Problem

A Problem titled "missing balance API" or "CSV export missing" tells a stakeholder nothing about what a user cannot do. It cannot be prioritized, and no one can tell when it is resolved.

Solution

Write each Problem so a non-technical stakeholder understands it at a glance.

  1. Title it Problem: [statement], under 65 characters.
  2. State what the user or business cannot do, in plain terms, not the solution's technicalities.
  3. Open it as a sub-issue of the Goal and link the Goal in the description.
  4. Give the body a # Problem section and a # Solution section describing the recommended approach before work begins.
Good:  Problem: operators can't view their account balance
Bad:   Problem: missing balance API        (a technicality, not a user problem)
Bad:   Problem: CSV export missing          (no actor, no action)

Acceptance Criteria

  • The title is Problem: ..., under 65 characters
  • It states a user or business inability, not a solution technicality
  • A non-technical stakeholder can understand it
  • It is a sub-issue of the Goal and has a Problem and a Solution section