search

nusCS2113-AY1920S1 / pe-dev-response

0 stars 0 forks source link

Documentation is very difficult to understand #1089

Open nus-pe-bot opened 4 years ago

nus-pe-bot commented 4 years ago

The documentation has been difficult to follow as it is not well organised and does not tally with the input from the program.

Firstly, tasks are mentioned at the beginning but the first few features shown are how to add receipts. Tasks are only shown at the end 4.2.1 despite features before it such as find being 4.8.

image.png

[original: nusCS2113-AY1920S1/pe-interim#1089]

Mudaafi commented 4 years ago

Team's Response

While the organization of commands can be improved, the UG itself is not incorrect. As such, it is not a Documentation Bug.

Given our target audience being users who are adept at using the Command Line Interface, it is not difficult to assume that they are capable of navigating the document via the Content Page or "Ctrl-F". As such, Severity has been reduced to Low as Users are still able to execute their desired commands and, given our target audience, only a mild inconvenience is incurred to them.

Duplicate status (if any):

--