summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide/feature.userguide.rst
diff options
context:
space:
mode:
authorDeepak S <deepak.s@linux.intel.com>2017-07-17 09:53:00 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-07-17 09:53:00 +0000
commit6e83256f8180f44b9e299420f16f2a9f931887ae (patch)
treef9ce530af44f695dfec006a63033beca4b45abf0 /docs/release/userguide/feature.userguide.rst
parenta0eb3c45ca8a89220caaefa43665a7a1eb6c1933 (diff)
parent272dd80f707564a7b810f46aef31b81994a0e1b4 (diff)
Merge "Documentation Compliance for Euphrates - Adding template"
Diffstat (limited to 'docs/release/userguide/feature.userguide.rst')
-rw-r--r--docs/release/userguide/feature.userguide.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 00000000..62259c7f
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
+.. 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.
+