summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/templates/release/userguide')
-rw-r--r--docs/templates/release/userguide/feature.userguide.rst10
1 files changed, 3 insertions, 7 deletions
diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst
index 733c2f99a..1d54d0ec7 100644
--- a/docs/templates/release/userguide/feature.userguide.rst
+++ b/docs/templates/release/userguide/feature.userguide.rst
@@ -2,26 +2,22 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-===================================
-OPNFV <Project Name> User Guide
-===================================
-
.. contents::
:depth: 3
:local:
<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.