From 21d59414fca273aade30aa4209aca9bb35a5f78f Mon Sep 17 00:00:00 2001 From: thmsdt Date: Tue, 2 Aug 2022 13:28:17 +0200 Subject: update and rearrange documentation related content Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797 --- .../templates/sections/design.rst | 32 ++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/guides/onap-documentation/templates/sections/design.rst (limited to 'docs/guides/onap-documentation/templates/sections/design.rst') 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. -- cgit 1.2.3-korg