Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 1.23 KB

README.md

File metadata and controls

18 lines (12 loc) · 1.23 KB

Guidelines for Architecture Design

Always design the architecture of a new system over an RFC🔒 (see definition). Get feedback from peers and whoever is possibly being impacted by it. Also make sure you also include @loadsmart/security to review it, as they are in a better position to spot any possible security flaw the new system may have.

It's also highly recommended that you include drawings in your RFC. The power of having something easy to visually digest makes everything easier to understand and avoids confusion and expectations that are poorly managed. You can use any tool for that: draw.io, Mermaid, Miro, or a simple picture of a physical white board taken by your phone.

Also:

  • Promote architectures that are loosely coupled and highly cohesive
  • Hide implementation details behind well designed interfaces
  • Use APIs to connect different systems
  • Don't build systems that are too big and with wide responsibilities