[4-KIT] Improve Arc42 Documentation

[ds-jhartmann]

As contributor, I want to have a clear and understandable documentation, so that participate quickly.

Hints / Details

System scope and context

• [ ] In-depth explanation of business context. Explain what the IRS does and how it does it. Maybe with a real-world problem/example. Give hints/entry points which will be described in detail in the concept
• [x] Describe what a submodel / aspect model actually is
• [x] Describe what AAS means when it is first used

Building Block view

• [x] Level 2 - TransferProcessManagement
  • [x] Add EDC context to DigitalTwinRegistryFacade and SubmodelFacade
  • [x] Diagram should reflect the decentral flow
• [x] Clarify the usage and differences of BlobStore and JobStore.
  • [x] Where are they used, what are they used for?
  • [x] How does cleanup work?
  • [x] Will information from the BlobStore be re-used?

Runtime View

• [x] Add introduction section to IRS Iterative and IRS Recursive where it is described how the two approaches work
• [x] Headlines of Runtime view chapters are on the same level when they should not be. Scenarios should be under IRS Iterative and IRS recursive.
• [ ] Add references to tests in Use Cases. This can make it easier to understand what is going on.

IRS Iterative

• [ ] Job orchestration flow
  • [ ] split up the diagram for better readability
  • [ ] flow does not seem to reflect the actual implementation (what are ApiEndpointExtension, WebService, ConsumerApiController, ConsumerService, DataRequestFactory?)
• [ ] Scenario 2: Job execution
  • [ ] use actual class names in diagram

IRS Recursive

• [ ] Use Case: ESS Top-Down - Flow on company level
  • [ ] simplify or split the diagram in smaller parts
• [ ] Scenario 1: Register an Ess-Investigation-Order
  • [ ] simplify or split the diagram in smaller parts
  • [ ] Remove outdated references to /irs/proxy
• [ ] Scenario 2: Register an Ess-Investigation Job
  • [ ] simplify or split the diagram in smaller parts
  • [ ] Remove outdated references to /irs/proxy

Deployment View

• [x] Remove Oauth references from deployment view

Cross-cutting concepts

• [ ] Check if domain concepts are still up to date
• [ ] Clarify if it is necessary to describe datamodels in the documentation

General

• [ ] Replace mermaid diagrams with plantuml in documentation (or enable usage of mermaid)
• [x] Guide: How to test my feature
• [x] Reference to umbrella chart if it is ready
• [ ] Add references to KIT documentation (connector kit, digital twin kit)

Outcome / Acceptance Criteria

Acceptance Criteria

• [ ] System scope and context updated
• [ ] Runtime View updated
• [ ] Deployment View
• [ ] Cross-cutting concepts
• [ ] only plantuml diagrams are used
• [ ] Guide for testing is added
• [ ] References to KIT documentation are added

[dsmf]

Also see the following discussion for further ideas how to improve the documentation: https://github.com/eclipse-tractusx/item-relationship-service/discussions/407

[ds-jhartmann]

Update documentation in https://github.com/eclipse-tractusx/item-relationship-service/pull/867