Edit artifacts yourself
How to change the Vision Statement and a Story Artifact by hand: opening a section, formatting, editing story sections row by row, saving and cancelling, and why a section sometimes does not open.
Updated
Your edits count like Speclr's
- Assessed againA section you save is assessed again, as after a change by Speclr.
- One author at a timeWhile you edit a section, nobody else can change it, Speclr included.
- Drafts stay draftsIn the draft of a new version, your edit goes into the draft. The committed version stays as it is.
Open a section
Click into the text of a section in the Vision Statement or in an open Story Artifact. The heading stays fixed; only the text below it changes. While you edit, the section shows a line at its edge, and you have one section open at a time.
Marking text with the mouse does not open the editor: it aims an instruction at Speclr instead. See Tell Speclr what to change.
Format Vision Statement text
The editor of a Vision section has four tools: "Bold", "Italic", "Bulleted list" and "Link", which asks for the link address. Lists and links are kept when you download the Vision Statement.
Edit a story section row by row
A Story Artifact section opens as rows of plain text, one per element. The button below the rows adds one; the bin beside a row removes it.
- "Business Rules": one rule per row, "Add rule".
- "Scenarios / Gherkin": one scenario per row, "Add scenario".
- "Actors": a name and the role "Primary" or "Stakeholder", "Add actor".
- "Non-Functional Requirements": "Add requirement".
- "Data Fields": "Field", "Type" and "Rules", one rule per line, "Add data field".
- "Boundaries": "In scope" or "Out of scope" and the boundary, "Add boundary".
Save or cancel
There are no buttons. Press Esc to cancel. Press ⌘↵ (Ctrl+Enter) or click outside the section to save. After five minutes without typing, the section saves itself.
Closing a section you did not change writes nothing. If a save fails, a message says why and the section keeps its last saved text.
Shared rules, actors and data fields
Business rules, actors and data fields belong to the project. Removing a row takes the entry out of this story; it leaves the project once no story uses it. While you edit such a section, the same section is locked in every story that shares one of its entries.
Changing an entry a finished story owns leaves that story's version as it was: your story gets the changed entry as a new one. See Context.
When a section does not open
- A teammate is editing it: "editing…" shows by the heading. See Working together.
- Speclr is writing it, or Pre Fill or Auto Mode is writing the whole artifact.
- The phase or story is finished, you opened an earlier version, or the project is archived. To change a finished artifact, start its next version: see Versions and drafts.
The story map
Activities, steps and stories are edited on the map in Exploration; milestones and the order of stories in Planning.
