Skip to content

DEV-050.md

Latest commit

 

History

History
26 lines (20 loc) · 806 Bytes

DEV-050.md

File metadata and controls

26 lines (20 loc) · 806 Bytes
Raw
id DEV-050
title Keep the Problem Statement Short
status active
enforcement manual
severity warning
depends_on
DEV-020

Problem

A long Problem statement buries the point in qualifiers and restated context. A reader cannot tell in one pass what is actually broken.

Solution

A Problem earns its place only if a reader gets the break in one pass. Name the single broken thing and stop. Motivation, context, alternatives, and any restating of the title belong in the Solution, or nowhere. The character cap is the forcing function: if you are over it, you are explaining, not stating.

Acceptance Criteria

  • The Problem paragraph is 250 characters or fewer
  • It states only what is broken, with no background or justification
  • It does not restate the title