SysML vs. Design Description

[CaverViking]

Hi!

I am using EA and SysML to describe my medical device. I have created a block diagram. I would like to describe each block with text and then generate a document that contains the block diagram and the description for each block.

Q1: Where/ how in EA should I capture the text description for each block?
Q2: Is there a good template that I can use for design description/ specification?
Q3: Does SysML specify where to capture the description? Should the description be captured in a internal block diagram for each block? Should blocks always be described by other diagrams instead of text?

Thank you

[Uffe]

Hello!

• Q1: Where/ how in EA should I capture the text description for each block?
  In the block's Notes property. If there's a lot of text, consider a linked document.
• Q2: Is there a good template that I can use for design description/ specification?
  The supplier-provided templates are generally not worthwhile, you need to create your own.¹
• Q3: Does SysML specify where to capture the description? Should the description be captured in a internal block diagram for each block? Should blocks always be described by other diagrams instead of text?
  Not sure about best practice wrt SysML, and I also suspect the answer is "it depends." But perhaps someone else has a better one.

¹Or get a consultant in hint hint.

/Uffe

[bknoth2]

I suggest that as soon as you have a few blocks described and diagrams drafted that you try generating a document. That process will help you understand how you want to organize the model and where you want to put the descriptive information, not to mention the challenges of generating documentation.