What's the intended pattern for a node whose full definition must be authoritative across many architecture documents? #3004
Unanswered
MattFriedman
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
When the same node appears in multiple architecture documents, what does CALM intend for reuse of its definition? I've worked through the existing mechanisms and none seem aimed at this, so I want to confirm whether there's a pattern I've missed or whether this is out of scope by design.
Three things people mean by "shared node"
These get conflated, so to be precise:
What I've checked and why it doesn't fit case 3
detailed-architectureis a drill-down link. The target is meant to contain the node's internal decomposition, not to be the node's definition. Using it to hold one node's canonical body inverts its purpose.Concrete example
Say an org requires governance metadata on every node — things like change status, provenance, deployment tier, region — plus interfaces and controls, all carried in the node body. For a genuinely shared service, that full body currently has to be re-authored in every architecture document it appears in. When it changes, every copy has to change. A standard keeps the shape consistent across files, but the content is still duplicated by hand.
What I'm trying to decide
Whether the intended answer is:
(a) there's a pattern for case 3 I haven't found, or
(b) re-declaration is expected, and instance-level reuse is deliberately out of scope — e.g. because a self-contained document diffs and reviews cleanly, and transclusion would hide cross-document impact from a reviewer.
Either answer is useful. If it's (b), I'd like that rationale stated so we can design around it rather than fight it. If it's (a), point me at it.
All reactions