search

ChrisLangton / pe

0 stars 0 forks source link

More missing sub-headers in DG table of contents under "Implementation" #9

Open ChrisLangton opened 3 years ago

ChrisLangton commented 3 years ago

image.png

The implementation section of the table of contents contains only the delete feature, it is missing:

which are actually contained in the DG.

soc-se-bot commented 2 years ago

Team's Response

overall issue is missing sub-headers but do not affect the overall readability of the document.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Missing sub-headers in DG table of contents under "Design"

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.

image.png

The table of contents is missing the 'Logic Component' and 'Storage Component' sub-headers.

[original: nus-cs2113-AY2122S1/pe-interim#2144] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

We believe this poses a minor inconvenience and does not affect the overall readability of our DG.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: Issues with the contents page definitely affect the readability of the DG. Most developers and individuals will not read through the DG cover to cover like a storybook, as this does not serve any purpose. They will read specific section(s) of the DG they wish to understand or implement, and use the contents page as the page off of which to navigate to the desired section. If sections are MISSING from the contents page, developers/individuals will likely assume these sections do not exist at all in the DG.