Explore Setting Up of User Guide for Future Students using CATcher

[seanlowjk]

As a student previous who took CS2103T and used CATcher, I initially had no idea how to setup CATcher and to use CATcher's functionality. Even though there were guides on CATcher's usage in CS2103T, it will be good that we have a user guide readily available on our website to bring the user through the different phases. For example, the Bug Reporting Phase and Tester's Response Phase

As such students will be able to view the user guide and learn how to work with CATcher during their Practical Examinations.

p.s. I am not sure which aspect to put it under, so I would put it under Documentation.

[seanlowjk]

I am thinking that if possible, we have a video guide for students on how to use CATcher, but I'm not sure if it would be too much. For now, I think we can stick to a simple user guide using GIthub Pages and Markbind!

[damithc]

Given that students survived without even a proper user guide so far (I didn't hear any complaints about it either), I think just a minimal user guide is enough. A video guides will be hard to update when the UI changes. Minimize screenshots and avoid animated gifs too.

[seanlowjk]

Alright Prof! Sounds good!

[anubh-v]

I think the UG should explain some of our application-specific keywords.
Example of such keywords: Pending issues / Faulty issues / Todos remaining

This will benefit developers who may not have used CATcher, as they'll be able to understand the application faster.

[anubh-v]

Another UG related TODO: updating the instructions for the web version
(Instructions specific to the desktop app can be kept in a separate section)

[seanlowjk]

Closing the issue for now as https://catcher-org.github.io/ug/index.html is in development