diff options
Diffstat (limited to 'docs/templates/release/userguide/feature.userguide.rst')
-rw-r--r-- | docs/templates/release/userguide/feature.userguide.rst | 27 |
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. + |