Skip to content
Snippets Groups Projects
Commit f9bc926c authored by Johannes Eder's avatar Johannes Eder
Browse files

Removed unused files 

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



Signed-off-by: default avatarJohannes Eder <eder@fortiss.org>
parent 82c9dc91
No related branches found
No related tags found
1 merge request!213866
Hide whitespace changes
Inline Side-by-side
Showing
with 0 additions and 159 deletions
org.fortiss.af3.rcp.help/html/MIRA.glossary2.html deleted 100644 → 0
+ 0
− 159
View file @ 82c9dc91
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of MIRA - Model-based Integrated Requirements Analysis.
@author becker
@ConQAT.Rating GREEN Hash: 850E39092E4DF6F9EEB6D26D886BEF68
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>MIRA - Creating a Requirements Glossary using AutoFOCUS3 (AF3)</title>
</head>
<body>
<h1><u><font color="#336699">MIRA - Model-based Integrated Requirements Analysis</font></u></h1>
<h2><font color="#336699">Creating a Glossary</font></h2>
A glossary is used to capture the vocabulary of the problem domain. Once created, the glossary is automatically linked to the requirements. Using the glossary it is easily visible whether the agreed vocabulary is used in all descriptions.
<br><br>
To create a new glossary, select <i>Glossary</i> in the context menu of a requirements analysis.
<br><br>
<img src="./pictures/MIRA.Glossary.NewGlossary.png">
<br><br>
<br><br>
You can create multiple glossary nodes with specific names (set in the properties view) to group your glossary terms.
<h3><font color="#336699">Creating Glossary Entries</font></h3>
In the context menu of the glossary node you can then create glossary entries by clicking <i>Entry</i>.
<br><br>
<img src="./pictures/MIRA.Glossary.NewEntry.png">
<br><br>
An alternative way to create a new glossary entry is to select a word in glossary entry, requirement source element or requirement editor, right-click on it and choose <i>Create glossary entry</i>.
If no glossary exists yet, a new one is created; if multiple glossaries exist, you are asked where the entry should be created.
<br><br>
<img src="./pictures/MIRA.Glossary.ContextMenu.png">
<br><br>
If no word is selected in the editor while choosing <i>Create glossary entry</i>, an appropriate word will be automatically chosen according to the actual context.
The chosen word is displayed in a confirmation dialog. Click the button <i>OK</i> to create a new glossary entry with this word.
If there is no appropriate word, an error dialog will appear.
<br><br>
<img src="./pictures/MIRA.Glossary.ConfirmDialog.png">
<br>
Confirm dialog
<br><br>
<img src="./pictures/MIRA.Glossary.ErrorDialog.png">
<br>
Error dialog
<h2><font color="#336699">Glossary Overview</font></h2>
By double-clicking on the <i>Glossary</i> node, an overview over all glossary entries opens.
<br><br>
<img src="./pictures/MIRA.GlossaryOverview.png">
<br><br>
The list of glossary entries can be sorted by clicking on the column headers of the overview list.
You can filter the glossary entries by inserting filter text in the filter section. Double-clicking on a column opens the corresponding glossary entry.
<h2><font color="#336699">Specifying Glossary Entries</font></h2>
For each entry you should at least specify the <i>name</i> (the vocabulary term it represents). In the <i>definition</i> field you should enter what this term means in your problem domain.
An entry also has a <i>status</i> field (Options: New, In consolidation, Consolidated) which can be used to consolidate it with others.
Furthermore you can specify <i>abbreviations</i> and <i>synonyms</i> for the entry and add a comment.
In <i>names</i>, <i>abbreviations</i> and <i>synonyms</i> only the special characters "-_/&rsquo;()" are allowed.
<br><br>
<img src="./pictures/MIRA.Glossary.GlossaryEntry.png">
<br><br>
For further description of the entry you can add pictures. To add a picture click on the <i>Add</i> button and choose an image file in the dialog.
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">
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.GraphDepth.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.GraphDepth.png

1.8 KiB

org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.NodeTypes.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.NodeTypes.png

6.27 KiB

org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.Overview.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.Overview.png

181 KiB

org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.RelationTypes.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.RelationTypes.png

7.1 KiB

org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.SearchTab.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.SearchTab.png

934 B

org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.StatusTab.png deleted 100644 → 0
+ 0
− 0
View file @ 82c9dc91
org.fortiss.af3.rcp.help/html/pictures/GRAPHVIEW.StatusTab.png

6.57 KiB

0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment