-
Epic
-
Resolution: Unresolved
-
Normal
-
None
-
Creating an architectural repository for ACM and MCE components
-
False
-
None
-
False
-
Not Selected
-
To Do
-
0% To Do, 67% In Progress, 33% Done
Epic Goal
Provide an INDEX of Architectural diagrams, flows and API's for all the components in ACM & MCE that we deliver
Why is this important?
There are a number of high level diagrams and many detailed diagrams that are scattered all over. This brings all the artifacts together in an easy to consume index.
Scenarios
- A cross component dependency. How does Application Subscriptions work. This component uses Application LifeCycle code and Search. By looking at the Applicaiton Architecture, it should be clear that Search is involved, and the INDEX can be used to learn aabout the search component as well as the application component.
- I am interested in the different parts of one of the ACM or MCE components, there will be an available architecture diagram, API model, and notes (if applicable)
Dependencies (internal and external)
- Where an Architecture diagram is missing, we find one
- API documentation - currently in the documentation, but we would like to automatically generate this.
-
- Using threat model
- Documentation has API reference as well
Previous Work (Optional):
- Documentation diagrams
- Architectural diagrams
- API reference
- Threat Model
Open questions:
- Do we bring some of these artifacts together over time
Done Checklist
- The beginnings of an INDEX