DG: Sequence diagrams are often on the page after their related instructions for manual testing

[nus-pe-bot]

There are too many sequence diagrams that end up on the page after their related instructions for manual testing to the extent that I believe they may hinder the reader.

Examples include

• Listing all contacts (p. 20-21)
• Deleting a contact (p. 22-23)
• Editing a contact (p. 24-25)

---

_{[original: nus-cs2103-AY2425S1/pe-interim#769] [original labels: type.DocumentationBug severity.VeryLow]}

[cth06-Github]

Team's Response

Thank you for your sharp observation. For the benefit of doubt, we interpret the issue you are seeing as:

When the sequence diagrams (which are after the text) are found on a separate page from the text, it runs the risk of leaving a big gap between the text and the diagram, making the text and diagram to be not in close proximity. This may be unideal as (1) the reader has to scroll up and down when he/she wants to see both the diagrams and the text simultaneously, thus hindering the reader and (2) in terms of organisation of documents, it does not make it as obvious that both the diagrams and text are within the same section.

If that’s the case (and we assume that’s what you mean), we wholeheartedly agree with you. Great catch! 👍🏼

Duplicate status (if any):

--