soc-se-bot
commented
5 months ago Team's Response
Hello! Thanks for pointing out this issue. Since this header and footer is introduced by pdf conversion and does not hinder the reader, we thought that it is not counted as a bug as seen in the screenshot below.
Also, page number is a requirement of the PE UG anyway (definition of paginated), so we wouldn't be able to remove the headers/footers even if we wanted to:
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Thanks for the response. I understand that the header and footer are introduced by the PDF conversion process, but there would be other means to add page numbers to the document and the headers and footers still affect the readability and aesthetics of the document, hence why I disagree what your team has mentioned.
Not to mention that each section title is very close to the headers on each page, as shown in the images below:
This, as well as the date "15/04/2024, 02:29" that is attached to each page causes the document to be more distracting and makes the UDG look less clean and less professional to the user.
When zoomed out, these headers and footers appear to be around the same size as the text itself, which is why I felt like it hinders the reader while they read the document and clutters the document unnecessarily.
To rectify this, it is actually possible to convert the PDF without the headers and footers, and instead add page numbers separately.
Doing so can make the user guide look cleaner and more professional, as mentioned above. Again, the document being paginated does not necessarily mean that it has to have headers: 15/04/2024, 02:32 ClinicMate Docs - Developer Guide - ClinicMate and footers: https://ay2324s2-cs2103t-f14-2.github.io/tp/DeveloperGuide.html#add-replace-note-feature on every page (not to mention that this footer embeds links on ever mention, and readers may accidentally click on it while scrolling the document given its common occurrence, which is inconvenient).
Furthermore, the developer guide footer link links to a very specific section of the DG, #add-replace-note-feature, instead of just linking to the main document. Since, this issue is labelled as severity.VeryLow, which highlights cosmetic issues (on top of hindrance caused to the reader when reading the document), so I believe that it should be accepted as a bug.
Similar to the user guide, the developer guide also has headers and footers that clutter every page of the DG, which can be removed as it does not add any additional useful information for the user when they view the DG.