search

Tohtoroo / pe

0 stars 0 forks source link

Should be mentioned in the userguide not just the developers guide with regards to the purpose of the application #20

Open Tohtoroo opened 1 year ago

Tohtoroo commented 1 year ago

image.png

Low as it is definitely a question one would have just by reading the user guide

soc-pe-bot commented 1 year ago

Team's Response

Then the person can read the User Guide. Don't see the point in repeating them.

Also here is what prof Damith mentioned in the website:

Aim to showcase your documentation skills. The primary objective of the DG is to explain the implementation to a future developer, but a secondary objective is to serve as evidence of your ability to document deeply-technical content using prose, examples, diagrams, code snippets, etc. appropriately. To that end, you may also describe features that you plan to implement in the future, even beyond v1.4 (hypothetically).

We have fulfilled that in the DG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: "Then the person can read the User Guide. Don't see the point in repeating them.

Also here is what prof Damith mentioned in the website:

Aim to showcase your documentation skills. The primary objective of the DG is to explain the implementation to a future developer, but a secondary objective is to serve as evidence of your ability to document deeply-technical content using prose, examples, diagrams, code snippets, etc. appropriately. To that end, you may also describe features that you plan to implement in the future, even beyond v1.4 (hypothetically).

We have fulfilled that in the DG."

The dev team did not really respond to my bug, what I am trying to say here is that that screenshot of the question is inside the DG, but it should be in the UG instead, since clearly, the question is not solely a question that a developer would have, but as well as the users of the application! "The person can read the user guide" is wrong since what I am saying here is that this information is not included in the user guide!

In fact in their UG, they deleted their entire FAQ segment, even though this portion in the DG is clearly a FAQ!

They might've been confused by the "Low as it is definitely a question one would have just by reading the user guide" but this was my reasoning as to why I put severity low, which is due to how this is a question one could have when reading the user guide, but they would experience inconvenience by not having an answer to this question since users should not be expected to read the developers' guide!