amanzainal / pe

0 stars 0 forks source link

Typo in DG #8

Open amanzainal opened 6 months ago

amanzainal commented 6 months ago

Minor typo in DG, page 7. Does not affect readability or cause any misunderstanding.

Peron -> Person image.png

soc-pe-bot commented 6 months ago

Team's Response

As the typo does not affect readability or cause any misunderstanding, we will fix this in future versions.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Dear Developer Team,

Thank you for your response regarding the minor typo identified in the Developer Guide. While I appreciate the acknowledgment of the issue, I'd like to emphasize the importance of addressing even seemingly minor discrepancies in our documentation.

  1. Adherence to Standards: As outlined in our course textbook and website, typographical errors (typos) are considered bugs if they hinder the reader's understanding OR detract from the quality of the documentation. In this case, even though it did not hinder my understanding that the documentation was referring to a "Person" and not a "Peron", it did detract from the quality of the documentation. A typo is still a typo. By adhering to these standards, we ensure that our documentation meets the expectations of our users and reflects positively on the integrity of our product.

  2. User Experience: Our users rely on accurate and well-presented documentation to effectively utilize our product. Addressing typographical errors, broken links, and other inaccuracies contributes to a smoother and more enjoyable user experience, fostering trust and confidence in our platform.

  3. In light of these considerations, I strongly recommend prioritizing the correction of the typo. By doing so, we demonstrate our commitment to excellence and professionalism, enhancing the overall user experience for our audience.

Thank you for your attention to this matter.