Name of the component
Introduction
Explain what is the component about and its architecture with a small architecture diagram.
Technical Specifications
Software and hardware Requirements
Which software and hardware are required to run the component.
Usage Manual
In this section the main features of the component should be identified and explained.
It also should include the explanation step by step each of the identified use cases.
Use Case 1.
Use Case Diagram
Explain with text, images, and mock-ups how the user will interact with the component to achieve their goal in that specific use case.
Use Case Mock-ups
Mock-ups are needed in the applications (for the mock-ups use the templates prepared in Figma).
Functional Specifications
Functional Block Diagram
Functional diagram showing the interrelationships between the functional (sub-)components. Explanation.
Main interfaces
List of main interfaces between functional components shown in the figure.
ID | Component | Name | Description | Sense |
---|---|---|---|---|
1 | Functional sub-component 1 | Name 1 | Description 1 | In |
Sequence Maps
Sequence maps showing the interactions between the functional (sub-)components. Explanation of flows.