summaryrefslogtreecommitdiffstats
path: root/docs/feature.templates/userguide/feature.userguide.rst
blob: b8adfa592c39718fc1c0446c63751474452088ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>

<Feature> description
=====================
.. Describe the specific features and how it is realised in the scenario in a brief manner
.. to ensure the user understand the context for the user guide instructions to follow.

<Feature> capabilities and usage
================================
.. Describe the specific capabilities and usage for <XYZ> feature.
.. Provide enough information that a user will be able to operate the feature on a deployed scenario.

<Feature and API usage guidelines and example>
-----------------------------------------------
.. Describe with examples how to use specific features, provide API examples and details required to
.. operate the feature on the platform.