Not Enough Details on Implementations

[KhoonSun47]

There are many commands in your applications, however, not all commands implementations are covered in the DG.

List of Implementations in the DG:

List of Commands in the UG:

[nus-se-bot]

Team's Response

The reported issue does not affect the quality of the documentation. The team thinks the features that are not included are trivial and do not require detailed explaination so not all the features are explained. Hence, it is rejected. Thanks!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: I disagree that this issue should be classified as "response.Rejected," and believe that it should be categorised as "response.Accepted" instead.

According to standard guidelines outlined in textbooks, the primary objective of a Developer Guide (DG) is to showcase your team's documentation skills.

It is intended not only to explain the design and implementation to future developers but also to demonstrate your team's capability to document deeply technical content effectively through prose, examples, diagrams, code snippets, and more.

Not documenting critical features in your application such as filter, export, and import (CLI) in the DG could significantly hinder future developers who may take over the project.

These features, which are not part of the standard AB3 AddressBook functionality, require documentation to aid in the readers in understanding their implementation and integration into the existing system.

By omitting these features documentation, it could potentially lead to confusion about how these features operate and their relevance to the overall application.

---