Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[116] ADR: Use Mural for diagramming and whiteboarding #122

Merged
merged 1 commit into from
Jul 7, 2023

Conversation

andycochran
Copy link
Collaborator

Resolves #116

This PR proposes the use of Mural for diagramming and whiteboarding.

Thinking about this tool from a cross-discipline perspective. There's overlap with eng/product/project needs. @acouch, it'd be good to get engineering's opinion on the MermaidJS bits. @sumiat / @widal001, it's be good to get your product perspective.

@andycochran andycochran marked this pull request as ready for review July 3, 2023 21:08
@sumiat sumiat mentioned this pull request Jul 5, 2023
4 tasks
@widal001 widal001 added the docs: adr Architecture decision record ticket label Jul 5, 2023
@acouch
Copy link
Collaborator

acouch commented Jul 6, 2023

This sounds great. We would use another tool for something like EDR diagramming or creating a network diagram but we can incorporate those as we go.

Copy link
Contributor

@sumiat sumiat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tool selected and justification makes sense to me! Figjam/Figma does offer an architecture diagramming tool so that would reduce the need for another tool in the future, like @acouch mentioned. However, I don't think that outweighs existing knowledge and licenses. Is it worth considering that we may want to reconsider switching when the Mural licenses expire?

Copy link
Collaborator

@widal001 widal001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me! I'll approve so we're not blocked on merging, but would love for @itsemilyianacone or @lucasmbrown-usds to sign off as well.

The Pros and Cons list make it really easy to see why Mural is an obvious choice, and the positive and negative consequences are thoughtful and help inform some other decisions in the project. Excellent work overall!


### Negative Consequences <!-- OPTIONAL -->

None, realy. There's a possible duplication of tool capabilities — Figma comes with Figjam, which has similar features; engineers may prefer MermaidJS for diagraming — which may justify further analysis in the future.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good call-out! Echoing @acouch and @sumiat, we'll probably use a separate set of tools for architecture related diagrams which have different requirements (e.g. version controlled, machine readable, etc).


### Positive Consequences <!-- OPTIONAL -->

- Mural can be used for sprint retrospective board, eliminating the need for an retro-specific tool
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a helpful observation! We do have "Sprint Retro Tool" listed as one of the ADRs associated with the Comms Platforms milestone. Mural should at the very least be one of the options we consider, if not the one we select just to get things rolling this sprint.


## Decision Outcome <!-- REQUIRED -->

Chosen option: Mural, because HHS has existing licenses and Nava has extensive experience using it for multiple purposes (diagrams, whiteboard, research synthesis, brainstorming, etc.). Mural is very effective as a collaborative drawing canvas. And it will be valuable to all disciplines for various purposes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Figma comes with Figjam, and has similar features, and we plan to already use Figma, wouldn't it reduce mental surface area needed and complexity to stick with one tool rather than learning two? Both tools are almost the same but worth noting different navigation, which personally isn't desirable for me. It's context switching without a lot of benefit. For simplicity sake, I like Figma + Figjam. Just chiming in!

@lucasmbrown-usds
Copy link
Collaborator

LGTM!

@lucasmbrown-usds
Copy link
Collaborator

@itsemilyianacone gave me a 👍 over chat on this, too

@andycochran andycochran merged commit 475a22c into main Jul 7, 2023
@andycochran andycochran deleted the andycochran/116-diagramming-tool-adr branch July 7, 2023 20:46
@sumiat sumiat added this to the Communication Platforms milestone Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: adr Architecture decision record ticket
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ADR]: diagramming tool
6 participants