search

mazfil / lab-allocator

COMP3500 - Resource maximisation planning system for labs
3 stars 1 forks source link

User support page with documentation and user guides #84

Open mazfil opened 3 months ago

mazfil commented 3 months ago

Continuation of old issue #59

Support page should include documentation and quick user guides. How to use the product and what to do in case of errors.

matthewcawley02 commented 2 months ago

I've created a new folder at docs/user-documentation for us to start writing our user documentation into. Eventually this folder will become a page on the frontend side.

matthewcawley02 commented 2 months ago

Re the above folder, I have added a guide for the timetable preferences (but without images yet).

Edward-Nivison commented 2 months ago

I am looking to work more on this after we complete our first user testing. This is so we can gain a better understanding of what our product looks like from an outside perspective and what we find intuitative and what others might not. This will give us invaluable feedback to develop further user documentation. See issue #96 for further developments on user testing.

Edward-Nivison commented 1 month ago

I am taking this on to get the wiki setup and getting some of the information and working on it over the next week.

Edward-Nivison commented 1 month ago

The button on the frontend doesn't seem to be taking it to the page I created, so I will be asking in the meeting about it with Filip if I have developed it incorrectly.

Edward-Nivison commented 1 month ago

Fixed the issue with the button, had some router issues in the frontend code. Trivial but I couldn't find it, thanks Filip.

Edward-Nivison commented 1 month ago

I have noticed that there are some changes to the style in the manage timetable, so I need to update the images for that. I will also check with the team in the tutorial today about the user documentation, if it should be plain text as it is now, or if it should have something else. We will see later on.

Edward-Nivison commented 1 month ago

I updated the photos so it reflects some changes made. Also added some stuff for the Manage timetable page. I am sticking with the text and images at the moment.

Edward-Nivison commented 1 month ago

I altered the styles and stuff for the wiki, will gather some more information regarding the support page from user testing.

Edward-Nivison commented 4 weeks ago

I have added the FAQs gathered from the user testing last week.