<COMPONENT NAME> User Guide¶
Target Users¶
Provide information on who your users are: Modelers, administrators, developers, etc
Overview¶
Provide an overview of the component and the use case.
Architecture¶
Provide high-level information about the feature components and how it fits into the Acumos platform. Detailed architecture should be part of the Developer Guide.
Note
Please do not include detailed internals that somebody using the feature would not care about.
How to Use <COMPONENT NAME>¶
Describe how to use the component
Tutorial¶
optional
If there is only one tutorial, you can include it in the User Guide. If there are several tutorials, it is better to create separate guides for each one.
<Tutorial Name>¶
Ensure that the title starts with a gerund. For example using, monitoring, creating, and so on.
Overview¶
An overview of the use case.
Prerequisites¶
Provide any prerequisite information, assumed knowledge, or environment required to execute the use case.
Instructions¶
This section should be step by step instructions on how to use the component. You can include screenshots and code samples to make the instructions clearer.