Diagram Standards¶
Inherit any Enterprise standards. However, these standards are often high-level, and implementation teams require more granularity with respect to standards and guidelines.
This page will be a living document that advocates for diagrams we will produce for each scope.
Theme: 4 R's¶
- Right Diagram
- Right Audience
- Right Channel/Method
- Right Time
Diagram Families¶
Selecting the right diagram is a skill in itself. There are several diagram families to choose from. The most frequently used are listed below. Hopefully you can rely on the skill of your architects to judge the right diagram type for the right audience that conveys the right level of information at the right time. (See 4 R's above)
Note: This is not meant to be a prescriptive list, but rather a listing of the most frequently used diagrams.
C4¶
- System Context Diagram
- Container Diagram
UML¶
- Component Diagram
- Sequence Diagram
ER¶
DFD¶
- Level 0
- Level 1
Cloud Diagrams¶
- Hybrid
- Context Dependent
Audiences¶
- US Leadership
- Irish Leadership
- Product
- Data Science
- Engineering
- Software Engineers
- Data Engineers
Published Diagram Must-Haves¶
- Legend
- Standard Icons (if CSP)
- Version history: (v0..n), Date, Author
- All flows/connectors numbered and footnotes of explanations & change history, where appropriate to do so.
- If published to Confluence, be published using the Gliffy integration.