summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/userguide/feature.userguide.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2017-01-24 19:48:42 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-01-24 19:48:42 +0000
commit5be018107412af7517893ed6a6a9c65f2f8d183e (patch)
treede010c4ceb904601e58a522b2edde75f319c886d /docs/templates/release/userguide/feature.userguide.rst
parent7eeb2e7767d243bd16ae160e58eb0326658dd910 (diff)
parent9fa0278a6646da9a79a3384c1abf920ece189430 (diff)
Merge "Adding all templates under templates/"
Diffstat (limited to 'docs/templates/release/userguide/feature.userguide.rst')
-rw-r--r--docs/templates/release/userguide/feature.userguide.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst
new file mode 100644
index 000000000..733c2f99a
--- /dev/null
+++ b/docs/templates/release/userguide/feature.userguide.rst
@@ -0,0 +1,27 @@
+.. 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>
+
+===================================
+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.
+