docs/guides/onap-documentation/templates/sections/design.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2021 ONAP contributors, Nokia
   4
   5 Design
   6 ======
   7
   8 ..
   9    * This section is used to describe the internal design structure of a
  10    software component.
  11
  12    * This section is typically provided: for a platform-component and sdk; and
  13      referenced in developer guides.
  14
  15
  16 Design principles
  17 -----------------
  18
  19 ..
  20   List the basic principles of the component and best practices, as well.
  21
  22 Static design
  23 -------------
  24
  25 ..
  26  Description of classes, objects, etc.
  27
  28 Dynamic view
  29 ------------
  30
  31 ..
  32   Communication/interaction of objects when implementing the use cases.