Reason (Why?)
Since we did many changes in the ddk-artbrowser project compared to the forked openartbrowser project and therefore we need to have a reference for us and for new coming developers.
Solution (What?)
We need to clearly document our changes in code as well as in our Wiki.
The following list is not exhaustive, so feel free to add documentation wherever you see the need.
Wiki
[ ] Data Model
[ ] Fronted: Update for the changes in ddk-artbrowser
[ ] Backend Architecture
[ ] Backend Part in Developer Guide (e.g. a "How to add a entity / field to an entity)
[ ] Further additions here
Code
Since the code should be written in a way that it is self-explanatory what happens, you should document especially why some things are done as they done (if it is not already clear). If it is unclear in some cases what the code does you might need to consider either to change the code to be more self-explanatory or add a comment and describe what is happening here.
Acceptance criteria
The wiki documentation represents the current code and data model state and serves as a well understandable getting started page for new developers. The code is documented in a way that new developers have as less problems as possible when starting to work with it (I know that this part is hard to evaluate, but the goal should be clear).
Reason (Why?) Since we did many changes in the ddk-artbrowser project compared to the forked openartbrowser project and therefore we need to have a reference for us and for new coming developers.
Solution (What?) We need to clearly document our changes in code as well as in our Wiki. The following list is not exhaustive, so feel free to add documentation wherever you see the need.
Wiki
Code Since the code should be written in a way that it is self-explanatory what happens, you should document especially why some things are done as they done (if it is not already clear). If it is unclear in some cases what the code does you might need to consider either to change the code to be more self-explanatory or add a comment and describe what is happening here.
Acceptance criteria The wiki documentation represents the current code and data model state and serves as a well understandable getting started page for new developers. The code is documented in a way that new developers have as less problems as possible when starting to work with it (I know that this part is hard to evaluate, but the goal should be clear).