docs/release/templates/userguide/feature.userguide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5 <Feature> description
   6 =====================
   7 .. Describe the specific features and how it is realised in the scenario in a brief manner
   8 .. to ensure the user understand the context for the user guide instructions to follow.
   9
  10 <Feature> capabilities and usage
  11 ================================
  12 .. Describe the specific capabilities and usage for <XYZ> feature.
  13 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
  14
  15 <Feature and API usage guidelines and example>
  16 -----------------------------------------------
  17 .. Describe with examples how to use specific features, provide API examples and details required to
  18 .. operate the feature on the platform.