Diagram Standards
Storage and Organization
Section titled “Storage and Organization”- All diagrams stored in
/docs/architecture - Use consistent naming conventions
- Version control alongside code
Content Requirements
Section titled “Content Requirements”- Highlight trust boundaries clearly
- Mark sensitive data flows
- Include relevant protocols and ports
- Document external dependencies
Maintenance
Section titled “Maintenance”Diagrams must be updated with any relevant architecture change:
- Adding new services or components
- Changing data flows
- Modifying external integrations
- Updating security boundaries
When Diagrams Are Mandatory
Section titled “When Diagrams Are Mandatory”- New services: All new services must have C1 and C2 diagrams
- INFRA onboarding: Required for any service requesting INFRA support
- Security reviews: Updated diagrams required for security assessments
Use LikeC4 for all architecture diagrams:
- Diagrams as Code approach
- Version controlled
- Consistent styling
- Easy to update and maintain