← Use spec sections guides

How to write the Purpose section

How-To Use spec sections Beginner 1061002HOWTO-1061002

HOWTO-1061002Use spec sectionsBeginner

This guide shows you how to write the Purpose section in a SpecDD .sdd file.

Purpose gives the reader the reason the subject exists. It should be short, stable, and implementation-neutral.

Short answer

Write Purpose as one or two body lines that explain the subject’s role. Do not put inline text after Purpose:. Avoid tasks, implementation details, and broad product essays. Use later sections for ownership, requirements, boundaries, and work items.

Syntax

Valid:

Purpose:
  Keep a trip itinerary organized by day.

Invalid:

Purpose: Keep a trip itinerary organized by day.

Rules:

Steps

1. State the durable reason

Good:

Purpose:
  Keep a trip itinerary organized by day.

This tells reviewers what the subject is for without describing every behavior.

2. Keep implementation out

Too implementation-heavy:

Purpose:
  Use a reducer, a storage adapter, and an event emitter to manage itinerary state.

Better:

Purpose:
  Keep itinerary state consistent while people add, move, and remove places.

Use Depends on, Handles, or other sections for implementation contracts when those details matter.

3. Keep tasks out

Do not write:

Purpose:
  Add validation for missing place names.

That is work, not purpose.

Use:

Purpose:
  Keep trip itinerary items valid and organized.

Tasks:
  [ ] Add validation for missing place names.

4. Make it specific enough to guide boundaries

Too vague:

Purpose:
  Manage trips.

Better:

Purpose:
  Let people arrange places into a day-by-day trip itinerary.

The better version helps reviewers recognize when booking, destination search, or account settings are outside this subject.

Common mistakes

How to verify the result

The Purpose section is strong when:

← Use spec sections guides