Skip to content
Snippets Groups Projects
Commit 461b307b authored by Andreas Bayha's avatar Andreas Bayha
Browse files

MIRA: Updated help

Replaced more outdated pictures.

Issue-Ref: 3949
Issue-Url: https://af3-developer.fortiss.org/issues/3949



Signed-off-by: default avatarAndreas Bayha <bayha@fortiss.org>
parent 11f9151f
No related branches found
No related tags found
1 merge request!223949
......@@ -59,81 +59,6 @@ You can add as many pictures as you want.
Each image has a description field which can be used to give information about the picture and to number the pictures.
If you click on an added picture, it should be displayed in full resolution in your systems picture viewer. <br>
When you add a picture it is copied into the <i>Images</i> folder in the project directory, next to your .af3_20 file.
If you want to send the model file to someone else, you should also send the <i>Images</i> folder.
<h2><font color="#336699">Consolidating Glossary Entries</font></h2>
The <i>status</i> field supports the consolidation of glossary entries (and requirement sources). We assume that there are two groups of persons involved in the consolidation process.
The first group of people documents the glossary entries; we call these persons the requirements engineers.
The second group of people has to agree on the terms in the glossary; we call these persons now the decision makers.
These groups can of course overlap or even be identically. Typically, these two groups are defined when a project starts. Typical members of decision makers are for example the client or the product manager.
<br><br>
Every requirement engineer can document new glossary terms and add definitions, abbreviations and so on. The status for new terms is <i>new</i>.
When a requirements engineer decides that the <i>new</i> term is sufficiently described, he can set the status to <i>in consolidation</i>.
For a terms that is <i>in consolidation</i>, the decision makers have to agree on that term, its definition and so on.
When all decision makers agree, then the status of this term can be set to <i>consolidated</i>.
If a term is <i>consolidated</i> and a decision maker thinks that this term is not defined correctly, then he/she can set the status back to <i>new</i> which triggers a new round of consolidation.
<br><br>
The <i>status</i> field can be filtered in the <i>Glossary Overview</i> in order to determine the list of terms that are
<i>new</i>, <i>in consolidation</i> or <i>consolidated</i>.
<!--<h2><font color="#336699">Connection between Glossaries, Requirement Source Elements and Requirements</font></h2>
<br>
After you specified your glossary entries, they will be highlighted when you use the terms in the glossary entries, requirement source elements and requirements specifications.
Blue color is used to mark a <i>name</i> or an <i>abbreviation</i> of a glossary term as well as requirement sources.
Red is used to mark a <i>synonym</i>.
<br><br>
The highlighting function features correct recognition of multiple word terms that are split by blanks or special characters.
Also terms surrounded by special characters like brackets or slashes are correctly highlighted.
An additional feature is the maintained highlighting with terms followed by plural "s" or "es" endings.
<br><br>
<img src="./pictures/MIRA.Glossary.Highlighting.png">
<br><br>
Furthermore matching glossary entries and requirement source element will be presented to you when you start typing a name and pause for a second.
If you choose one of the suggestions, the rest of the name will be inserted automatically.
<br><br>
<img src="./pictures/MIRA.Glossary.Autocomplete.png">
<br><br>
When you hold the mouse cursor for a second on a highlighted term, a pop-up will show additional information.
In the pop-up you can see the definition of the glossary entry/requirement source element and whether the marked occurrence is an abbreviation
or a synonym of this entry/element. If the entry contains images, the first image is shown in the pop-up window as well.
When you click on the name in the pop-up, the editor for this glossary entry/requirement source element will be opened.
<br><br>
<img src="./pictures/MIRA.Glossary.PopupHover.png">
<br><br>
If there are two or more requirement source elements and/or glossary entries with the same name, <i>Stakeholder</i> has the highest priority, and then <i>Document</i>,
then <i>External system</i>, and at last <i>Glossary Entry</i>. Name with higher priority is in the front of pop-up and the highlight color is the color of the name/term with highest priority.
<br><br>
<img src="./pictures/MIRA.RequirementSource.Priority.png">
<br><br>
The glossaries always belong to one <i>Requirements Analysis</i> node. The glossary entries of one <i>Requirements Analysis</i> node will not be highlighted in another <i>Requirements Analysis</i> node.
<br><br>
<h2><font color="#336699">Glossary Occurrences</font></h2>
<br>
By double-clicking onto a Glossary Entry, an overview over all glossary entry occurrences page is opened as a second window.
<br><br>
In the usage statistics section, the number of <b>exact</b> occurrences of the glossary term in <i>Documents</i>, <i>Requirements</i> or another <i>Glossary Entries</i> is given,
as well as in <i>Arrays</i>, <i>Enumerations</i> and <i>Structures</i> which are found in the data dictionaries.
The Filter option helps to filter the list of occurrences. Each element of the list can be opened by double-clicking the entry in the <i>Overview</i> section.
<br><br>
Additionally, the search can be extended to similar words via the <i>Similarity</i> slider. Similar terms are then included in the overview list.
The similarity is calculated based on the <a href="http://en.wikipedia.org/wiki/Levenshtein_distance">Levenshtein Distance</a>. Every step of the
slider increases the search distance by 1, thereby allowing more words with bigger differences in the overview list. The similarity search respects plural endings and special chars to a certain extent.
Words shorter than 4 letters, for example abbreviations, are excluded from the similarity search,
as this would lead to bulk lists containing nonsense.
<br><br>
<img src="./pictures/MIRA.Glossary.GlossaryOccurences.png">
-->
If you want to send the model file to someone else, you should also send the <i>Images</i> folder.
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png

11.6 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png

12.8 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryEntry.png
  • 2-up
  • Swipe
  • Onion skin
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png

13.2 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png

15.2 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.NewGlossary.png
  • 2-up
  • Swipe
  • Onion skin
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png

10.8 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png

20.9 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewAnalysis.png
  • 2-up
  • Swipe
  • Onion skin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment