Minimal description for "Storage" class in DG

[kyhjonathan]

The above screenshot is the only description about the Storage Class in the DG. More developer descriptions should be added in order for better understanding of how this class works.

Suggestions:

1. Add in Class diagram and sequence diagram.
2. Add in the path of the txt file that stores the data
3. Add in the format of how the tasks are stored into the txt file.

[nus-se-script]

Team's Response

Thank you for the suggestion. We understand that it is a valid issue. However, regarding the Storage Class, we believed that the code comments explaining each method was sufficient in explaining what each of the methods do in the storage class and ,hence, only included when these methods are invoked as we believe this was the only unclear issue about the Storage Class.

Moreover, our main focus on the Developer Guide was to focus on the main features of BudgetBuddy, etc (adding, editing ,loading of expenses/savings) which is why our implementation sections were significantly longer, and with more diagrams as compared to this section here.

Therefore, we agree with the Medium Severity as the lack of extra information may cause inconvenience to developers who do not have access to the code, however, we have classified this as NotInScope as this was not of a higher priority than the explanations of the implementations in the DG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

• [x] I disagree

Reason for disagreement: I feel that this should be in scope, because the whole point of the DG is for readers to be able to understand easily the workings of the program.

The reason of not including more explanation about the class because they wanted to concentrate on the "main features" explanation is invalid because there is no downside of including more explanations of the other features and classes. This only hinders developers understanding of the class, which leads them to spending much more effort in trying to understand the code.

FAQ: How detailed the DG should be? Do we have to describe every feature/component? Answer:

The DG is primarily meant to help current/future developers. Therefore, decide based on how the inclusion/exclusion affects that target audience (you belong to the target audience too!).

Above is taken from CS2113 website. The exclusion of explanation strongly hinders the target audience(developers) understanding.

---