Help

How to use Speclr

Download artifacts

What you can download from a project today, finished stories as a feature file or specification and the domain knowledge from Context, and why the download button is sometimes greyed out.

Updated

Every download starts from the same place: the download icon ("Export") at the end of the side bar beside the artifact. What it offers depends on what is on screen. Downloads are files on your computer; nothing is sent anywhere.

What you can download

  • A finished storyAs a Gherkin feature file or as a Markdown specification.
  • Domain knowledgeThe glossary, the rule book or the full context, each as Markdown.
  • Nothing else yetThe Vision Statement and the story map cannot be downloaded.
  1. Open a finished story

    In Refinement, open a story whose status is "Finished". Only a committed story can be downloaded. See Finish a story.

  2. Choose a format

    Choose the download icon ("Export") in the side bar and pick one:

    • "Feature File (.feature)": the story’s scenarios as a Gherkin feature file.
    • "Story Specification (.md)": a Markdown specification with business rules, data model, non-functional requirements, acceptance criteria and what is out of scope. Rules the story links from elsewhere in the project are included, and a "Risks" section lists the risks the story rests on.
    File name
    story number and title, e.g. 12-reset-password.feature
    Version
    always the committed version

Download the domain knowledge

Open Context from the side bar. While it is on screen, the download icon offers the project’s domain knowledge instead of the artifact:

  • "Glossary · N terms": every glossary term with its meaning.
  • "Rule book · N rules with actors and data fields": the business rules with the actors and data fields they use.
  • "Full context · everything in this view": all of it in one file.

Each file is Markdown named after the project, for example acme-portal-glossary.md. It holds the current entries of the scope you chose ("Base" or "Base + draft"); tabs, search and filters do not narrow it.

The download icon is greyed out

Nothing on screen can be downloaded:

  • the story is not finished yet;
  • a draft of the story is open (see Versions and drafts);
  • Context has no entries yet;
  • you are looking at the Vision Statement or the story map.

Downloads during a new version

While you work on the next version of a story, its download is not offered. Finish or discard the draft, then download the new committed version.

Sending stories to your tools

To connect Speclr to GitHub, an organisation admin sets up the connection once. See Connect GitHub.