damithc / foo

0 stars 0 forks source link

[UG] adding file to file list #46

Open damithc opened 4 years ago

damithc commented 4 years ago

actual destination: nus-cs2113-ay1920s2/pe-moderation

Issue Description

:information_source: 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.


There is insufficient information to guide the user on how to add a file to file list. There could be a demo file to show the user the step-by-step guide on adding the file list.


[original: benchan911/pe#8]


Team's Response

Hi, addf command is elaborated in UG from page 13 to page 14 with screenshots attached. I think it would be sufficient to guide the user on adding a file to the File List.

To Check [1 Items]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Sorry I do not think its a functionalityBug but rather a documentationBug.

image.png

The example usage given has double '\' before the desktop which broke the file path.

image.png

Only when I remove the additional '\' , then it is fixed. Perhaps, a video would be better for documenting this because a new user would need to know how to put the file and get the file path. You would need to cater for new users who are not familiar with the concept of file path