nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Lack of other diagrams #3644

Open nus-se-script opened 2 months ago

nus-se-script 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.


As a developer, the DG is well-written but could definitely be improved with more diagrams such as Activity Diagrams to show the flow of each command


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

Joseph31416 commented 2 months ago

Team's Response

Thank you for pointing it out. However, as you mentioned, the DG is already well-written and more diagrams are a good to have to show the flow of each command. As such, we determined that adding more diagrams was less important than the task of adding more essential commands that improve the program's functionality. Thus, we classify this bug as not in scope as it satisfies the definition of not in scope (see screenshot). We will add more diagrams in the future.

Screenshot 2024-04-21 at 1.27.19 AM.png

Duplicate status (if any):

--