Design Guidelines

#Design format A design document should be provided in .md format (http://markdownpad.com)

Design document template

Design document should contain the following

• DB schema
• Flows and SAI APIs
  1. Includes all configuration flows, system events, etc covering all UIs required to be supported.
  2. Includes interactions with other modules.
  3. Detailed description of SAI API and the parameters to be used.
  4. Flows should be in UML format.
• Debug dump and relevant logs
• Memory consumption
• Performance
• Should call out if any platform specific code will be introduced and why. Need to avoid platform specific code from the design phase
• Future: error flows handling
• Future: show commands

Design review

Prior to design review session the design document should be available for community for being able to provide feedback.

• Design review should be scheduled and published. Until finalized it can be via email.
• Design review should have feature owner and the relevant development team as well as arch owner.
• Design should start only after design document is approved.