search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Activity diagram in Tutorial Tags section in DG has no context #3770

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.

image.png

The following diagram is confusing to new developers, as it has no context to it.

The bigger problem here is that there are 2 separate commands being executed here, so it can leave the developer confused if he/she is unfamiliar with the code base.

I would recommend adding relevant text to support what is going on in the diagram, since the mark command appears here as well.

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

wang-xinrong commented 2 months ago

Team's Response

The context is explicitly stated in the first screenshot "The following activity diagram depicts a typical flow of how a user would add a new tutorial group."

image.png

And the mark command can only be issued after the Tutorial tag is added, so the activity diagram is relevant and correct.

Duplicate status (if any):

--