Speedweener / pe

0 stars 0 forks source link

Absence of images in UG #15

Open Speedweener opened 3 years ago

Speedweener commented 3 years ago

image.png

Rather than using markdown formatting, i think it would be better to include images of the app and expected output. Else, it becomes harder for the user to compare the guide with the app.

More images would also make the user guide more visual and appealing to read. At the moment I feel that there is a bit too much text.

nus-pe-bot commented 3 years ago

Team's Response

Thank you for your feedback. Due to the cross-platform nature of SCRUMptious, it is hard to cater to all types of platform and therefore we have decided it is better to generalise it and provide the code and output using markdown. We believe that it should not be that hard to compare since we are explicit in stating that it is a code or an output.

Example:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Regardless, I feel that the lack of images in the UG is still quite apparent, and readers might be put off by the continuous wall of text.
While it is true that the application should be cross-platform, I think generalizing and providing the code and output using markdown is not a good compromise. Most users would benefit from images of the default black and white command line interface, while those who have different command line interfaces should still understand the images as well as the current markdown format, maybe even better as the images are more distinct from the rest of the user guide.

Additionally, perhaps a diagram could be used to show how the different aspects of the project planner work together with each other (eg. Project has Sprints, Sprints have tasks, task can be assigned to members) for new users who might just be learning about SCRUM, or how the program automatically assigns subsequent sprint dates based on the first sprint.

Severity.Level Low