search

dqualizer / domain-story-modeler-thesis

Thesis: A tool to annotate Domain Stories with RQAs
http://domainstorytelling.org
GNU General Public License v3.0
0 stars 0 forks source link

readme

Deprecated

The contents of this project have been moved to the dqanalyzer component. This project is not maintained any longer.

Domain Story Modeler

A tool to visualize Domain Stories in your browser.

About

https://domainstorytelling.org

Run the Modeler

Important: Starting with v1.0.0, the modeler requires that your browser allows third party cookies (How to turn on third party cookies in Firefox and Chrome). We rely on storing your modeler's configuration in your browser. That enabled us to develop a cool feature that allows you to choose which icons you want to use for modeling (see below).

Usage

This is a short guide on how to use the Domain Story Modeler. We recommend to switch your browser to full screen mode (in most browsers: press F11 key) to increase the available modeling space.

Palette

Shows the icons you can choose to record your Domain Story (actors and work objects), a rectangular shape to group icons into logical units, and two useful modeling tools:

Headline

Click on the headline to change the name of the Domain Story and describe it. The description can contain information about assumptions (e.g. that the domain story describes a "happy path" scenario) and variations (e.g. optional activities). Use ctrl+enter or alt+enter to add line breaks to the description.

Context Menu

If you drop an icon from the palette into the canvas you will see a context menu with three sections:

Naming Actors and Work Objects

Double click on an actor's or work object's icon to edit the name. To rename multiple work objects, click the dictionary button Dictionary Button.

Naming and Numbering of Activities

Activities are depicted as arrows. Double click on an arrow to edit the activity's name. If you model an activity between an actor (person, people and system) and a work object (folder, call, email, conversation, information) it will be numbered automatically. By double clicking on the arrow or the number you can manually change the number. All other numbers are adjusted automatically.

If you want to model activities that happen simultaneously, check the "multiple" checkbox of an activity. This allows you to use the same number multiple times, indicating that these activities happen in parallel. These steps are shown at once in the replay mode.

Save, Open, and Export Domain Stories

If you want to save your Domain Story, download it as a .dst file by clicking the export button Export Button or pressing ctrl+s on your keyboard. To continue working on a Domain Story, import a .dst file using the upload button Upload Button.

You can also export your diagram as a .svg, .png, or animated .html file by clicking on the image button SVG Button and selecting your preferred format. Beginning with version 1.2.0, the .svg file contains an embedded .dst file. That means that you only need to download one file that you can use as picture and also edit it later by importing it again. Exporting the domain story as animated HTML presentation is a beta feature introduced with v1.3.0.

Replay

The replay feature helps you to re-tell a Domain Story sentence by sentence. When you start a replay with the play button Play Button, all activities except the first one disappear. Clicking the forward button Forward Button shows the next activity and clicking the previous button Previous Button shows the previous one. The current sentence is highlighted. If a Domain Story contains groups, the are hidden an first and then appear as last step at the end of the story. Editing is disabled in replay mode, but you can zoom (ctrl + mouse wheel up and down), scroll up/down (mouse wheel up and down), and scroll left/right (shift + mouse wheel up and down). You can also move the modeling canvas by keeping the space bar pressed and move the mouse around. The stop the replay, click the stop button Stop Button.

Keyboard Shortcuts

Click on Keyboard Button to display all available keyboard shortcuts.

Configuring the icon set

We recommend that the icon set is adapted to the domain that you model. You can configure the palette accordingly and share that configuration:

Click on Gear Button to open the icon configuration. Configure your icon set by naming it, selecting which icons should be used as actors or as work objects and order these icons (using drag&drop). You can export your configuration as .domain file. To switch between configurations, import a different .domain file.

If you import a Domain Story from a .dst file, your icon configuration will change automatically to the one with which the Domain Story was created - even if you do not have the corresponding .domain file.

Beta feature: If you want to use icons that are not in the predefined set that comes with the modeler, you can upload your own icons. Different image formats are allowed, but you will achieve best results with SVG because it is scalable (like the icons that come with the modeler). Also, we recommend to use square images because they look better in the pallet and the context pad. If you want a consistent look, consider using the same icon set that we use for the predefined icons: https://material.io/resources/icons/?style=outline

Examples

You can download these examples and import them into the modeler.

For Developers

Download the source code or clone the repository. Please note that we use the main branch for development. The main branch contains the latest features and bug fixes, but they might be undocumented and tested less thoroughly than a release. To be on the safe side, stick with the latest release branch.

Fetch dependencies:

npm install

Build and open the modeler in your browser:

npm run dev

Create distributable bundle:

npm run all

License

The Domain Story Modeler is licensed under GPLv3.0. The Modeler uses bpmn-js which is licensed under the bpmn.io license.

GPLv3.0

Copyright (c) 2018-2021 WPS - Workplace Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

bpmn.io License

Copyright (c) 2014-present Camunda Services GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The source code responsible for displaying the bpmn.io project watermark that links back to https://bpmn.io as part of rendered diagrams MUST NOT be removed or changed. When this software is being used in a website or application, the watermark must stay fully visible and not visually overlapped by other elements.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.