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

Analyze the project architecture #96

Open
2 of 3 tasks
CSchoel opened this issue Jul 15, 2021 · 2 comments
Open
2 of 3 tasks

Analyze the project architecture #96

CSchoel opened this issue Jul 15, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@CSchoel
Copy link
Contributor

CSchoel commented Jul 15, 2021

  • Use UMLet (or any other UML editor) to visualize the top-level project architecture
    • It is more important that diagrams are focused on what is important rather than that they are valid UML.
      Please omit any information that is not relevant for the purpose of giving an overview over the project and feel free to add non-standard information that is.
  • Go through the Wikipedia page on software design patterns and identify...
    • ... patterns that are implemented in the code of other libraries, and that are used in the project,
    • ... patterns that the project itself implements,
    • ... and patterns that the project does not yet implement, but that could be implemented in future versions
  • Summarize your findings in a new wiki page called "Project architecture"
    • This page should also contain a few sentences that justify and explain the architecture shown by the UML diagram
@manuEbg manuEbg added the documentation Improvements or additions to documentation label Jul 20, 2021
@manuEbg
Copy link
Contributor

manuEbg commented Aug 5, 2021

The current Progress on this issue can be find in the documentation-branch. Especially this folder.
I have a few Ideas and Question considering design patterns. I will try to summarize them tomorrow early in the morning.

@manuEbg
Copy link
Contributor

manuEbg commented Aug 6, 2021

Moved this Issue from "In Progress" to "Active Sprint" so I can work on other Issues and take a little distance from the topic to return to it at another time more open minded :)

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

No branches or pull requests

2 participants