summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-documentation/templates/sections/design.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-documentation/templates/sections/design.rst')
-rw-r--r--docs/guides/onap-documentation/templates/sections/design.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/guides/onap-documentation/templates/sections/design.rst b/docs/guides/onap-documentation/templates/sections/design.rst
new file mode 100644
index 000000000..66c5f3651
--- /dev/null
+++ b/docs/guides/onap-documentation/templates/sections/design.rst
@@ -0,0 +1,32 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 ONAP contributors, Nokia
+
+Design
+======
+
+..
+ * This section is used to describe the internal design structure of a
+ software component.
+
+ * This section is typically provided: for a platform-component and sdk; and
+ referenced in developer guides.
+
+
+Design principles
+-----------------
+
+..
+ List the basic principles of the component and best practices, as well.
+
+Static design
+-------------
+
+..
+ Description of classes, objects, etc.
+
+Dynamic view
+------------
+
+..
+ Communication/interaction of objects when implementing the use cases.