search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Undo and redo commands can be explained better #732

Open nus-se-script opened 11 months ago

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

While the undo and redo commands are useful in their own right, the explanation can be better, as they are currently structured in a single paragraph.

image.png

To make matters worse, there is use of technical terms like stackable. Even though its meaning is explained, it is still off putting to the target audience.

I suggest that the explanation is phrased in bullet points (similar to the other commands) so that it is easier for the user to read. An example demonstrating how the command is undone/redone will also be useful.

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

Kokseng1 commented 11 months ago

Team's Response

The more "technical" terms are thoroughly explained and readers would most likely be able to understand how the command works without a demonstration because it is very intuitive. Our target users are CLI users and undo/redo is a feature that is extremely commonplace in computer systems. We also think that the explanations are short enough such that it does not need to be put into bullet point form.

Duplicate status (if any):

--