---

NOTE: This is a template from Software Architecture Documentation Template for the content that should be included in every type of view (not just for module views).

---

Module View 1

Primary Presentation

• Is usually graphical
• Should include a key that explains the notation
• Shows elements and relations among them
• Shows the information you want to convey about the view first
• Should identify elements that are external to scope of the view
• If external entities are not clearly marked in the diagram, consider adding a context diagram

Element Catalog

• Explains elements depicted in primary presentation and their properties
• Is usually a table with element name and textual description
• May contain interface documentation
• May contain behavior documentation

Variability Guide

• Points where system can be parameterized or reconfigured. Examples:
  • Number of instances in a pool
  • Support for plug-ins or add-ons
  • Support for different versions of OS, database server or runtime environment
• Maybe the view is a reference architecture
  • Provide guidelines to instantiate it

Other Information

• Description and rationale for important design decisions (including relevant rejected alternatives)
• Results of analysis, prototypes and experiments
• Context diagram

Related Views

• Relation (Parent, Refinement, Common elements, etc). Name of view and a link to it.