[PP-1] Diagram tying the product requirements + decisions together

Created on 14 June 2024, 14 days ago
Updated 20 June 2024, 8 days ago

Problem/Motivation

First, go and read the issue summary of πŸ“Œ Record Architecture Decisions β€” to scale to many people + many timezones Fixed .

Excerpt from there:

We need, at least:

  1. product requirements broken down into concrete issues (a graph of issues, with concrete issues that can be implemented in a single MR) to work towards that first concrete goal (#3454094), ⚠️ knowing full well that these will be incomplete: we're first working towards that first concrete goal, then expanding scope
  2. a record of decisions (and these decisions may need to be revisited too)
  3. a diagram tying the product requirements + decisions together

This issue is realize that third point.

3 days ago, I wrote in Drupal Slack:

Steps to reproduce

N/A

Proposed resolution

Following that, @ctrlADel β†’ messaged me:

c4 diagrams https://c4model.com/ would be great. I don't find the render one particularly easy to digest but then again it's a complicated area. Happy to help make a pretty/cleaned up version of the diagram as well

… which led me down the path of first starting to build a C4 diagram in OmniGraffle β€” the same tool I used to create that render pipeline diagram years ago. But this made me realize that ideally the diagram could be edited by anyone, and ideally would be versioned.

So I searched and found … https://structurizr.com/ β€” which:

While maybe imperfect, this is clearly far better than multiple paying for an OmniGraffle license just to be able to edit a diagram, and neither versioned, nor diffable, nor exportable, etc.

So: let's try it.

Remaining tasks

User interface changes

None.

API changes

None.

Data model changes

None.

πŸ“Œ Task
Status

Postponed

Component

Documentation

Created by

πŸ‡§πŸ‡ͺBelgium Wim Leers Ghent πŸ‡§πŸ‡ͺπŸ‡ͺπŸ‡Ί

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.69.0 2024