Help

How to use Speclr

Finish a story

How to commit a story’s version in Refinement, what holds it back, and how to change it later.

Updated

Finishing commits a version

  • A version of its ownThe story gets version 1 with an optional comment, and becomes read-only.
  • Changes go through a draftA finished story changes only through its next version.
  • Ready to downloadA finished story can be downloaded as a feature file or a specification.
  1. Open the finish step

    With no session running on the story, choose "Finish this story…" below the conversation.

    Speclr can also suggest finishing, or you can ask it to. The finish step then opens by itself. Speclr never finishes a story; closing the step leaves it in progress.

  2. Clear what holds it back

    The commit is refused until:

    • the story has Business Rules and at least one scenario;
    • no element of it is marked for review. Postponed markers count too; "Show markers" takes you to them;
    • no session is running on it. End it with "End session" in the chat input;
    • nobody is still editing it;
    • the story’s quality check is done. While it runs, the dialog says "Speclr is checking the story. You can commit once the check is done." and the button reads "Quality check running…". Without a check, choose "Run quality check".
  3. Commit the version

    The dialog is titled "Finish this story · Version N". Add a "Commit comment (optional)", for example what was agreed, and choose "Commit version N".

    With team alignment on, the dialog shows how many members are ready. If not everyone is, it asks "Why finish before everyone is ready?" and records your answer on the version. See Team alignment.

    After the commit the story is finished and stays open, read-only.

    Once it is finished, you can download the story as a feature file or a specification. See Download artifacts.

Change a finished story

Choose "Start version N+1…" below the conversation and confirm. You work on a draft; version N stays as it is until you commit. Finishing the draft replaces it. If the draft’s changes reach other stories, the finish step first asks what they affect. See Versions and drafts.

Earlier versions

"Version N" in the bar above the artifact lists the versions of the story with date, comment and who committed it. "Open version N" shows one read-only; "Back to version N" returns.

Troubleshooting

  • "Business Rules and at least one Scenario are required…": add them, then try again.
  • No "Finish this story…": a session is still running, or the story is already finished.