soc-se-bot
commented
6 months ago Team's Response
We did consider grouping similar portions together. However, taking into consideration that our project is rather complex, we came to a consensus that giving each individual section an indepth and full explanation would improve clarity for each individual section.
By splitting up each portion, then grouping similar parts and moving it to the back of the DG, it might be troublesome and can create confusion as one would need to go back and forth to fully understand the specific component they are currently reading (ie. constantly checking which part is relevant or not). This is taking into consideration that our DG has approximately 60 pages and flipping back and forth between different pages is quite inconvenient.
Additionally, as we have added component specific examples to drive our points, grouping them together might mislead readers further, causing a more severe documentation bug.
Lastly, with reference to the suggestions given in the course material, it is advised that explanations are kept near the diagrams. In this case, our developer design considerations for each component are also reflected in their respective class diagrams.
https://nus-cs2113-ay2324s2.github.io/website/admin/tp-deliverables.html#deliverable-user-guide-ug
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
From UI:
From Command Parser:
From Storage:
From Reflection:
A number of considerations are repeated, just with different examples at each section e.g. SRP, Code Readability, Exception Handling.
Perhaps the Developer Considerations can be placed at 1 section, with a few references to different components instead? Certain developer considerations that do not apply to all can be left at each section.