eclipse-tractusx/eclipse-tractusx.github.io

Digital Twin KIT Improvements

Closed this issue · 4 comments

mhellmeier commented

When reading the Digital Twin KIT, different things can be improved to make it better understandable for externals unfamiliar with the topic. Concrete todos:

  • The Operation View is very minimalistic. It would be great if more information about every component could be provided (some sentences for every element, what it does, etc.)
  • The Operation View mentions the "BPN" without defining what a BPN is
  • The Interaction Patterns page mentions specificAssetIds and globalAssetId. Both are not defined in the document. To make it better understandable, it would be great to give a short definition and example for every ID
  • The Interaction Patterns page mentions "Industry Core (coming soon)". Since the Industry Core is published, it can be linked
  • (optional) It would be great if one descriptive picture could be added that shows an example of an AAS / Digital Twin with more than one submodel to illustrate the overall AAS concept for people not familiar with it
arnoweiss commented
arnoweiss commented
  • The elements of the operation view are explained in the table. I'm unsure what further context could help a reader. If you have suggestions, feel free to leave them here or contribute to the PR.
  • The multiplicity of submodels I tried to convene with the figure in the operations view. What else would you wish for?
mhellmeier commented
  • The elements of the operation view are explained in the table. I'm unsure what further context could help a reader. If you have suggestions, feel free to leave them here or contribute to the PR.

To give an example, the "Digital Twin Registry" is described in the table of the Operation View as "A registry for digital twins, each digital twin providing the endpoints of its submodels."
A person new to the concept who doesn't know what a digital twin is will ask what can be found in this registry. Are there only the endpoints? Can I find metadata in this registry? Will there be specific data points?
Another example is the Discovery Finder, which is described as "[a] microservice resolving type of identifiers against a set of BPN-Discovery Servers."
New users don't know what "type of identifiers" are because they are missing the context.

I still think adding 1-2 sentences to every service could help users to understand each concept.

  • The multiplicity of submodels I tried to convene with the figure in the operations view. What else would you wish for?

I think if the table had some more details, the picture would be more understandable for newcomers. Therefore, updating it as described should be okay.

arnoweiss commented

pushed a couple of updates to the linked PR. hope that clarifies it.

  • 👍1