nus-pe-script
commented
1 year ago Team's Response
We agree that adding diagram headings and labels might improve a DG's quality, but as the tester mentioned, the context of our diagrams (as well as the diagram given by the tester as an example) are made explicit in our DG through our accompanying paragraphs and headers. A developer would still be able to understand our diagrams well because of that. Furthermore, it is not a module requirement to include headers and labels for our diagrams.
Thus, we reject the bug since it is not a requirement and since the contexts of our diagrams are clear.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Although the dev team has provided good accompanying paragraphs the external developers who would like to read this developer/user guide can't be expected to go through the connected paragraph every time they have to reference a diagram. A title and a label although not explicitly mentioned as a requirement aids in the understanding, navigability, and speed of access and understanding of the user. A hindrance to this is still considered a bug. Furthermore, there are also formatting concerns that affect the quality of your DG. Labeling would also make these diagrams referencable improving the understandability of your DG. These are the multiple concerns that warranted a very low rating from the tester. Thus, the tester respectfully disagrees with the dev team.
Description: Diagrams in the developer guide do not have proper titles and labelling.
Image of bug:
Reason for bug level: As the image has no heading and image italicized label it decreases ability to be referenced. However, the severity is very low as there are good accompanying paragraphs but diagram headings and labels are a must and depict the quality of the developer guide.