Updated 1. Software Requirements Specification (markdown)

Florian Kaiser 2021-11-04 20:31:33 +01:00
parent 1648ed1e19
commit 4a277ffbd1

@ -1,34 +1,25 @@
#### Table of Contents
* [1. Goal](#Goal)
* [2. Use Cases](#UC)
* [2.1 <UC.001> “Create new device”](#UC1)
* [2.2 <UC.002> “Create interface or load interface from Library”](#UC3)
* [2.3 <UC.003> “View device data and device interface data”](#UC4)
* [2.4 <UC.004> “Reloading and editing an AML device description”](#UC5)
* [2.5 <UC.005> “Add Attachments for the Device”](#UC6)
* [2.6 <UC.006> “Format output as CAEX version 3.0”](#UC7)
* [3. Non-functional Requirements](#NF)
* [3.1 /NF10/Overview](#NF1)
* [3.2 /NF20/Load Attributes](#NF2)
* [3.3 /NF30/Application Load Toolbar](#NF3)
* [3.4 /NF40/Application Load Window Sizing](#NF4)
* [3.5 /NF50/Rename Documents](#NF5)
* [3.6 /NF60/Resizable Rows](#NF6)
* [3.7 /NF70/Header Overview](#NF7)
* [3.8 /NF80/Design of the Buttons](#NF8)
* [3.9 /NF90/Design of the Tabs](#NF9)
* [3.10 /NF100/Code Quality](#NF10)
* [4. Functional Requirements](#F)
* [4.1 /F10/Link to Manual](#F1)
* [4.2 /F20/Add Button at Interfaces](#F2)
* [4.3 /F30/Mechanical and Hydraulic Interfaces](#F3)
* [4.4 /F40/CAEX 3.0 Output](#F5)
* [4.5 /F50/Parameter Requirements](#F6)
* [4.6 /F60/Delete Empty Fields](#F7)
* [4.7 /F70/Delete Button](#F8)
* [4.8 /F80/Testability of AML device](#F9)
* [2.1 <UC.001> Create new device](#UC1)
* [2.2 <UC.002> Create interface or load interface from Library](#UC3)
* [2.3 <UC.003> View device data and device interface data](#UC4)
* [2.4 <UC.004> Add Attachments for the Device](#UC6)
* [2.5 <UC.005> Format output as CAEX version 3.0](#UC7)
* [3. Features](#LF)
* [3.1 <LF10> Import](#LF1)
* [3.2 <LF20> File validation](#LF2)
* [3.3 <LF30> Error Handling](#LF3)
* [3.4 <LF40> GUI](#LF4)
* [3.5 <LF50> Display device in a readable way](#LF5)
* [3.6 <LF60> Edit device](#LF6)
* [3.7 <LF70> Create device](#LF7)
* [3.8 <LF80> Export device](#LF8)
* [4. Product data](#LD)
* [4.1 /LD10/ AML-DD](#LD1)
* [4.2 /LD20/ Save and load files](#LD2)
* [5. Bug Fixes](#B)
* [6. Enhancements](#Enhancements)
* [6. Enhancements](#E)
* [7. References](#Ref)
# Changelog
@ -152,6 +143,10 @@ The system shall create a valid AML-DD with all the necessary information the or
The system shall make a device description editable. For this, the user can load existing or create new devices within the interface of the application. After editing them, these descriptions can be saved to a location selected by the user.
# 5. Bug fixes <a name="B" />
# 6. Enhancements <a name="E">
# 7. References <a name="Ref"/>
[1] https://github.com/Rajkumarpulaparthi/ModellingWizard <a name="1"/>