search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency in the amount of implementation details provided for each feature in the Developer Guide #4327

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.

The 'Design consideration'. and usage scenario has not been provided for the Operating Hours feature, while it has been provided for the alias and log features. This makes the DG content and formatting a bit inconsistent.

[original: nus-cs2103-AY2122S1/pe-interim#4394] [original labels: severity.Low type.DocumentationBug]

qreoct commented 3 years ago

Team's Response

Not an issue.

Some feature implementations were described more thoroughly, while others deliberately mentioned only the necessary details.

Since "The DG is primarily meant to help future developers. Therefore, decide based on how the inclusion/exclusion affects that target audience." (from Textbook), the description of Operating Hours (and Amenities) are left to only the key factors, as they are simple to understand, in comparison to Alias and Log features. We felt there is no need to elaborate further about usage scenarios and design considerations.

Duplicate status (if any):

--