Help

How to use Speclr

Your project workspace

A tour of a project's workspace: the phase tabs and their status, the chat beside the artifact, the version bar, the side bar, the project settings and archived projects.

Updated

Every phase of a project opens in the same workspace. Here is what you find where.

Phase tabs

The tabs at the top switch between Discovery, Exploration, Planning and Refinement. A tab stays locked until the phases before it are finished. Point at a tab to see where it stands, for example:

  • "Not started"
  • "Version 1 in progress", or "Version 1 · finished" with the date
  • "In progress · 3 of 12 stories finished" in Refinement
  • "Session running" while Speclr works in that phase
  • "Based on an older version of Discovery" when an earlier phase has a newer version

You can switch phases while a session runs; it keeps running. On smaller screens a phase selector replaces the tabs.

Chat and artifact

You talk to Speclr in the chat. Beside it is the artifact of the phase: the Vision in Discovery, the Story Map in Exploration and Planning, and in Refinement the overview of stories or the Story Artifact you opened. On a narrow screen, a switch toggles between "Chat" and the artifact.

The bar above the artifact

It shows the artifact's name and version. A "Draft" pill means the version is still being worked on; "Finished" and "Read-only" mean it is committed.

Choose the version, for example "Version 2", to open the "Version history": every committed version with its date, comment and who committed it. "Open version 1" shows an older version read-only; "Back to version 2" returns. While the draft of a next version is open, "Discard draft…" throws it away. See Versions and drafts.

The side bar

Next to the artifact, a bar of buttons changes what you see:

  • Artifact view: the artifact itself.
  • Code view: the artifact as its Markdown source, read-only. Not offered on the Refinement overview.
  • Changes: appears while the draft of a next version is open, with the number of changes in it.
  • Conflicts: active when the project's domain knowledge has open conflicts; opens Context narrowed to them.
  • Context: the project's domain knowledge in place of the artifact. See Context.
  • Risks: the risk register in place of the artifact, with a badge for what is new. See Risks.
  • Files, Memory and Constitution: what the team added, what Speclr has learned about the project, and what everything in it has to comply with. See Add files.
  • Export: downloads a finished story, or Context while it is open. See Finish a story.

Project settings and team

The gear at the top right opens "Project Settings"; the team avatars next to it open its Team tab. See Project settings and team.

Archived projects

An archived project shows a banner: its team can read everything but change nothing until the owner restores it. See Manage your projects.