search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Overuse of diagrams in DG #1279

Open nus-pe-bot opened 2 months ago

nus-pe-bot commented 2 months 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.

Under the implementation section, there are 8 activity and sequence diagrams with the first half of the sequence diagrams often repeating. While very comprehensive, I think there is unnecessary bloat in the documentation. I would suggest one or two sequence diagrams to give the general flow then just keeping the activity diagrams as they tell the reader information easier.

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

tohlh commented 2 months ago

Team's Response

Thanks for pointing out!

However, we believe that being comprehensive in the documentation is better than intentionally excluding certain information. We aim to make each sub-section of the DG self-contained so that developers can quickly refer to all the information needed.

Hope that clarifies your concerns.

Duplicate status (if any):

--