In the user guide, some "note" sections are very long and can be confusing to read.

[nus-pe-bot]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

It is overwhelming for the user as the notes section lists a lot of points together:

Perhaps some of the points could be explained outside the note block? For example using the screenshot above, the syntax/restrictions of item price and item name could have been separately explained with their own paragraphs.

---

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

[zikunz]

Team's Response

Thank you for your reply! :)

However, we are unable to accept it as a bug.

First of all, we were already considerably selective when it comes to presenting important notes (as shown in your screenshot, for the items add case, there are 9 notes) because the target users should be informed about all the important notes when using a particular command. We have also made the notes as concise and easy-to-understand for our target users as possible. Thank you for your suggestion to put the points outside the note block. We are unable to and should not put all the notes in the error message of the program because the user should know where he / she is wrong in the quickest time possible.

Secondly, it is also not plausible to put them in other parts of the UG because the format we use for all commands are context / story, step-by-step-instruction, notes, expected output and return to top. Hence, the screenshots are only for the output and it might not be a good idea to include different content inside (which confuses the users). It is also more suitable to be notes rather than a large chunk of paragraph which is less readable.

Hope you can understand our concerns and rationale.

Duplicate status (if any):

--