Help

How to use Speclr

Context: your project's domain knowledge

What Context holds, how to find and read an entry, where open conflicts show, and how to export the glossary, rule book or full context.

Updated

Context is your project's domain knowledge in one place: business rules, actors, data fields and glossary terms. It is project-wide: every phase reads it, and stories link the entries they need.

Where the knowledge comes from

  • Discovery, Exploration, PlanningAt the end of every turn, Speclr adds the rules, actors and glossary terms it established.
  • RefinementWritten live while you refine a story. Data fields come only from here.
  • Shared by storiesStories link entries instead of copying them, so all read the same rule.
  1. Open Context

    Choose Context in the side bar beside the artifact, in any phase. The view is headed "Project · Domain knowledge". You read entries here; to change one, tell Speclr in the chat.

    Choose Context again to return to the artifact.

  2. Find an entry

    Each tab shows how many current entries it holds: "All", "Rules", "Actors", "Data fields", "Glossary". The search, "Search terms, rules, fields…", covers every category.

    "Conflicts" and "Unused" appear when something qualifies. "Replaced" also shows entries that were replaced.

    Conflict
    in an open conflict
    Unused
    linked by no story, once refinement has begun
    Replaces 1
    replaced an earlier entry
    New, Changed, Retired
    what an included draft changes
  3. Open an entry

    Choose a row to open it.

    • History: where it was recorded, or what it replaced, with the reason, who gave it and a link to that conversation.
    • Used by: the stories that link it and their state. Choose one to open it in Refinement.
    • Validations for a data field, Terms in this entry for the glossary terms it mentions, and Mentioned in for a glossary term.
  4. Export the knowledge

    While Context is open, the export button in the side bar offers "Glossary · N terms", "Rule book · N rules with actors and data fields" and "Full context · everything in this view". Each downloads Markdown of the living entries in the current scope, ignoring tabs, search and filters.

Conflicts

While you refine a story, Speclr notices when a statement contradicts an existing entry and asks you which one holds. The Conflicts button in the side bar counts the entries in an open conflict and opens Context on them. See Resolve conflicts.

Base or Base + draft

Context opens on "Base", the knowledge everyone works with. While the artifact on screen has an open draft of version 2 or later, the title bar also offers "Base + draft", and Conflicts opens on it. See Versions and drafts.

Committed knowledge is protected

Once the phase or story that recorded an entry has a committed version, later work no longer overwrites it: a change becomes a new version of the entry that takes effect once that work is finished. Old versions show the knowledge as it was.

Nothing shown yet

A new project says "Nothing has been recorded yet." Context fills as the team talks to Speclr.