search

Capeguy / pe

0 stars 0 forks source link

Developer Guide - Missing Sections #22

Open Capeguy opened 4 years ago

Capeguy commented 4 years ago

In developer guide section 3.1, it states that

Users are able to:

  1. add events

  2. delete events

  3. add notes to events

However, in the next section (3.1.1), only deleting of events is mentioned, without adding of events or adding notes to events.

nus-pe-bot commented 4 years ago

Team's Response

It is stated in the CS2103T textbook that "Guideline: Document Minimally, but Sufficiently", "Aim for 'just enough' developer documentation." and "Writing and maintaining developer documents is an overhead. You should try to minimize that overhead. If the readers are developers who will eventually read the code, the documentation should complement the code and should provide only just enough guidance to get started." in page 69. Hence there is no need to list every nitty little details about every features.

Furthermore, even if it was a bug, a severity of low rather than high will be more suited since it does not affect the reader using the DG as there are many other information like the class diagrams that can allow them to understand how the application runs.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As a developer reading the Developer Guide, I am unable to know how to add an event or add notes to events.

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: Not knowing how to add an event or add notes to events will prevent me from further understanding the application, let alone develop it.