search

cagov / odi-engineering

California Office of Digital Innovation engineering documentation
MIT License
2 stars 0 forks source link

Complete diagram of ODI Publishing #52

Closed chachasikes closed 2 years ago

chachasikes commented 2 years ago

Zakiya started a diagram of the ODI Publishing system and shared it with Jon & Chach.

We used Figma's FigJam to edit the technical diagram.

We would like more feedback from non-engineers on the diagram so that our diagram is accurate to how the system is built, and useful for all our team members and partners who might want to understand how our system is configured.

Note: @aaronhans also created a great system architecture diagram of the hardware system (It's in @cagov/drought.ca.gov.)

chachasikes commented 2 years ago

@zakiya and @xjensen Let's schedule a session with Zain and Liz sometime later this week to get some feedback on our diagram.

jaredwyee commented 2 years ago

My unsolicited 2 cents: I think it's good to have a high level abstraction diagram for non-technical folks

But also have a more detailed architecture diagram for engineers + an architecture approach doc/documentation. Both of which are living archifacts that change as the architecture may change.

adam-little commented 2 years ago

Can you share a link to the Figjam?

jaredwyee commented 2 years ago

https://www.figma.com/file/oxejuAbLaxVW4itp00uv32/ODI-Publishing

chachasikes commented 2 years ago

Notes from engineering meeting:

chachasikes commented 2 years ago

I will schedule the next meeting.

chachasikes commented 2 years ago

Pausing this til we catch up. A good outcome for this would be a couple of slides to be able to use in presentations.

chachasikes commented 2 years ago

Updates:

jaredwyee commented 2 years ago

First draft of super abstracted diagram https://docs.google.com/presentation/d/1rhY8S-4XW9V6OHDM0u5aGqsn5K3KGnsZ0HS1iAcXfhc/edit#slide=id.p

chachasikes commented 2 years ago

This really has evolved! It's a stellar dynamic system diagram now. Go us. :)