search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Structure looks not well-formatted. #1199

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

There is no clear sub-headings for each feature and it was difficult to see all the features provided by LocationBuddy.

Either a summary of a table of features, a list function to show all the features or a table of contents will be useful.

Explanations were very brief as well.

Overall, the user guide looks very rushed and messy to comprehend.

image.png

[original: nus-cs2113-AY2021S2/pe-interim#1199] [original labels: severity.High type.DocumentationBug]

tehtea commented 3 years ago

Team's Response

  1. Clear subheadings were provided in markdown (see https://raw.githubusercontent.com/AY2021S2-CS2113-T10-2/tp/master/docs/UserGuide.md).
  2. There are only five main features. Do you really need a list of all features in a two-page document?
  3. Regarding explanations, the amount of explanations per feature is roughly equivalent to the one given in the AddressBook example (see https://github.com/nus-cs2113-AY2021S2/addressbook-level3/blob/master/docs/UserGuide.md).

Duplicate status (if any):

--