diff options
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst index f173a2fb5..66c5f3651 100644 --- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst @@ -1,13 +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 ====== -.. note:: - * This section is used to describe the internal design structure of a software component. +.. + * 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. - * This note must be removed after content has been added. + +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. |