Skip to content

Diagram Standards

  • All diagrams stored in /docs/architecture
  • Use consistent naming conventions
  • Version control alongside code
  • Highlight trust boundaries clearly
  • Mark sensitive data flows
  • Include relevant protocols and ports
  • Document external dependencies

Diagrams must be updated with any relevant architecture change:

  • Adding new services or components
  • Changing data flows
  • Modifying external integrations
  • Updating security boundaries
  • 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