Repetitive sequence diagrams in DG

[nus-pe-bot]

I believe this application has 4 main features: Expense, Recurring Payment, Income and Target. The DG is unbelievably long with rather repetitive sequence diagrams, and essentially 1 sequence diagram was created for every command. I don't think having more sequence diagram value adds to the DG, especially when its so repetitive.

What can be done instead is to orchestrate a user workflow for particular feature, so readers can understand what each command is about and how it works together to value add to users.

For example, the user wishes to add expense, edit the expense, then delete the same expense. All these can be explained in steps and illustrated in 1 diagram, instead of having 3 diagrams for every command. That would make the DG more understandable in my opinion.

Example of 2 commands with very similar sequence diagram (occurs throughout the DG):

---

_{[original: nus-cs2113-AY2223S1/pe-interim#807] [original labels: severity.Low type.DocumentationBug]}

[xzynos]

Team's Response

Greetings yongjicode,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) A sequence diagram was included for every command to make it easier for the user to understand the interactions between the different components at a glance. It illustrates the different command handler functions that handles each command as well as the corresponding parameters passed to the different components of the programme. It was a conscious design choice based on the feedback we've received as it allows a developer to navigate through the developer guide using the content sections and see exactly how each command works without the need to scroll.

2) The reported issue does not affect the functionality of the developer guide and we are not accepting suggestions as bugs.

Regards, xzynos

Duplicate status (if any):

--