search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Wordiness of Both Guides #788

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.

I would say that both the user guide and the developer guide are a bit wordy and sometimes repeats information that has already been established in later sections of the guide. I think defining all of the variances of entering the variables in a separate section and then utilizing those variables in the definition of the commands could really cut down on the overall visual clutter.

[original: nus-cs2113-AY2223S1/pe-interim#760] [original labels: severity.Low type.DocumentationBug]

owenl131 commented 1 year ago

Team's Response

Description provided is vague. Developer guide is meant to be comprehensive. For the user guide, we intend command sections to be standalone to minimize the amount of jumping around that the user needs to do. To spread out the information density, we also provide a quick start at the start and a command summary at the end so that the user can take in information slowly.

Duplicate status (if any):

--