Add documentation about bemanitools architecture #27

Open
opened 2019-09-29 00:46:22 +03:00 by icex2 · 0 comments
icex2 commented 2019-09-29 00:46:22 +03:00 (Migrated from github.com)

Summary

Provide a high(er) level view of the overall architecture of the project.

Detailed description

Write a document that gives a high level view of bemanitools architecture and how various modules integrate with it. Give reasons about the decisions taken and point out their benefits and drawbacks (if applicable).

Benefits

  • Major architecture decisions are documented.
  • Improve onboarding of new developers.
  • When adding new features, the architecture can be re-evaluated easier if the new feature fits already without major changes or, if changes are required, how they impact the current architecture and what needs to be changed.
## Summary Provide a high(er) level view of the overall architecture of the project. ## Detailed description Write a document that gives a high level view of bemanitools architecture and how various modules integrate with it. Give reasons about the decisions taken and point out their benefits and drawbacks (if applicable). ## Benefits * Major architecture decisions are documented. * Improve onboarding of new developers. * When adding new features, the architecture can be re-evaluated easier if the new feature fits already without major changes or, if changes are required, how they impact the current architecture and what needs to be changed.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Max/djhackersdev_bemanitools#27