System architecture diagram
- Last UpdatedOct 22, 2024
- 1 minute read
Have an architecture diagram that shows an overview of what is running and where. The key point here is that it is an overview and should at a glance let people know what is running. Guidelines for the architecture are:
-
Make it graphical so it’s easier to see where components are in the system topology.
-
Include all servers and include locations on network segments.
-
Include the clients as a group, such as Operator Stations, Engineering Stations, and Office Users.
-
Include the networks and firewalls.
-
Include where the major components are running and the names of database instances.
-
Generally do not include versions. An exception would be for key component versions that would require an update to the architecture diagram (e.g., the OS version).
-
Try to keep the diagram to one page if possible.
-
For examples, see the architecture diagrams in MES solution design.