<Application> Software User and Maintenance Manual¶
| Author: | Name Surname |
|---|
Change Record¶
Introduction¶
Purpose¶
Describes the purpose of the document, and the intended audience.
Scope¶
Describes the scope of this requirements specification.
Applicable Documents¶
Reference Documents¶
Glossary¶
Overview¶
Hardware Architecture¶
This section should give an overview of the corresponding HW environment that is related to the application, referring to the involved devices, their deployment, etc.
Devices and Components¶
Involved HW devices (if applies) should be mentioned here, technical details should be mentioned at an appendix.
Hardware Layout Diagram¶
If applies, a general HW layout diagram could be shown here. This diagram should focus on the devices mentioned before, plus WSs, Ethernet backbones, gateways, subsystems, etc.
User Manual¶
This section contains general descriptions, screenshots, etc., that explain how to use the application. Some examples are:
Application Start-up¶
Application Shut-down¶
Alarms¶
GUIs¶
Maintenance Manual¶
This section should contain all the information necessary to maintain the application. For example, it should describe the SW structure, how to perform configuration changes, software package names, basic package requirements, dependencies, etc.
Application Documentation¶
If applies, you could mention here any other relevant application documentation like README files, etc.
Class Diagram¶
If not automatically generated, this section could contain a class diagram.
Application Program Interface (API)¶
If not automatically generated, this section could contain the application’s API.
Package Diagram¶
Gives the name(s) of the involved packages and shows the package diagram.
Error Definitions¶
If applies, you could mention here the error definitions that apply for the application.
FAQ and Troubleshooting¶
Here you could write down FAQs and any relevant hint for the application’s troubleshooting.