Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a more detailed architecture description #603

Open
h4uges opened this issue Sep 28, 2023 · 0 comments
Open

Provide a more detailed architecture description #603

h4uges opened this issue Sep 28, 2023 · 0 comments

Comments

@h4uges
Copy link
Contributor

h4uges commented Sep 28, 2023

To help new developers get started and to establish a common understanding of the architecture within the development team, a more detailed architecture description is needed.

The documentation should provide information about ...

  • which modules exist (on package/project level)
  • and for each module ...
    • its purpose/function
    • its provided interfaces/functionality
    • its ensured invariants
    • its depencencies
  • how typical use cases are solved by Vitruv and which modules are involved

Also concepts which are spread across many modules should be explained in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant