search

AidenLYT / pe

0 stars 0 forks source link

Missing implementation documentation #12

Open AidenLYT opened 7 months ago

AidenLYT commented 7 months ago

Description

There are missing documentation on additional features added on top of the original AB3, such as marking attendance, deleting a person.

Ideas

It would be nice to add those documentation, otherwise it would be legacy coding or those commands. Causing difficulties for future programmers to improve on this TA Toolkit.

nus-pe-script commented 6 months ago

Team's Response

Hi, we are not sure what you mean by this since our UG have usage instructions for the new features added and deleting a command as well. The documentation for marking attendance is in page 9, and documentation for delete command is in page 9 as well.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: [replace this with your reason]

image.png With reference to the DG given, under the implementation(as specific in the topic title) section, only edit a person, view a person and proposed undo/redo function is being documented. There is not documentation of other functionality.

The bug report also specified "future programmers" referencing to the use of DG and not UG, where focuses on users perspective. Since there is no implementation documentation of other functionalities specified in UG and not DG, it causes trouble for programmers to work on the future iteration of this product.