Help

How to use Speclr

Constitution

What the Constitution holds, how to add and remove its rules, and how Speclr uses them in what it writes.

Updated

The Constitution holds what your organisation and this project require of everything they build, such as the systems to use or the approvals to get. Every phase observes it in everything it writes. A rule reads, for example, "All products use the internal IAM system." or "Client photos never leave the EU."

What a rule is for

  • Set by the teamEvery member of the project team adds and removes the project's rules.
  • Read every turnSpeclr reads the rules in the order they were added, in every phase.
  • From now onA new rule shapes what Speclr writes next, not what is already written.
  1. Set rules before you start

    In the composer of a new project, the pill "Constitution: none" or "Constitution: N rules" opens the dialog "Constitution". See Create a project.

  2. Add a rule

    In the workspace, choose Constitution in the side bar. The view "Constitution" lists every rule that holds in the project.

    Choose "Add rule", type the rule and press Enter or the plus button. Escape cancels. Keep one requirement per rule.

  3. Remove a rule

    Point at a project rule and choose its × button. It is removed at once. A rule without a × comes from your organisation and holds in every project.

How Speclr uses the Constitution

Speclr’s agents in Discovery, Exploration, Planning and Refinement read the rules as constraints and non-negotiables. In Refinement, a quality goal from the Constitution that applies to a story becomes a Non-Functional Requirement with the pill "Constitution".

A new rule applies to what Speclr writes from then on. It does not go back over what is already written; to apply a rule there, tell Speclr what to change.

Who can change rules

Every member of the project team can add and remove its project rules. In an archived project the rules are shown and cannot be changed.

Constitution, Memory or Context?

The Constitution says what everything has to comply with. Memory holds facts about the project, Context the knowledge about the product, and Risks what could go wrong.