Skip to content

Simplify the Architecture Design Workflow

Grzegorz Bizon requested to merge docs/gb/architecture-design-workflow-changes into master

Why is this change being made?

The merge request introduces following changes to the Architecture Design Workflow:

  1. Rename "Architecture Evolution Workflow" to "Architecture Design Workflow", to make a better connection with industry-wide adoption of design documents.
  2. Rename the "Architecture Evolution Coach" to just a Coach Engineer.
  3. Make involving the Coach Engineer optional, but strongly recommended in a couple of situations.
  4. Document these situations in the handbook too, to make it clear when it is strongly recommended to involve a Coach Engineer.
  5. Advise against using the workflow when someone is doing something they have a lot of experience with.
  6. Simplify the Workflow as much as possible.

The main goal here is to simplify the process, so that it is frictionless enough to become widely used at GitLab.

Author Checklist

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
    • The when to get approval handbook section explains the workflow in more detail
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Grzegorz Bizon

Merge request reports