diff --git a/UserGuide.md b/UserGuide.md index 20f8f4ed52..a14ef9f3a4 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -2,7 +2,8 @@ ## Table of Contents 1. [User Story 2](#user-story-2) -2. [User Story 7](#user-story-7) +2. [User Story 5](#user-story-5) +3. [User Story 7](#user-story-7) ## User Story 2 As a student, I want to receive an immediate notification when a course faculty member replies to my post, so that I can review their response within 24 hours. @@ -42,6 +43,32 @@ As a student, I want to receive an immediate notification when a course faculty #### Test Justification We believe that these tests are sufficient as it tests the basic functionality of this new feature. The tests ensure that users receive notifications from faculty, can differentiate between faculty and regular user replies, and can manage notifications (e.g., marking them as read or adjusting settings). This ensures both the functionality and user control of the feature, making the system reliable. +## User Story 5 +As a TA, I want to filter through posts that have questions about the homework rather than the assignment, so I can answer one topic before switching to another topic. + +### Feature Overview +* Automatically Generated Tags for TAs: + * The system automatically assigns "Homework" and "Assignment" tags when NodeBB starts. + image + * TAs can filter posts based on these tags to focus on specific topics (e.g., only questions about homework or only questions about assignments) + image + * This feature is designed to improve the organization and efficiency of managing a high volume of posts, allowing TAs to focus on one topic area at a time without distraction. + +### How To Use and Test User Story 2 Feature +1. Start NodeBB using the command ./nodebb start (locally or on a server). The "Homework" and "Assignment" tags should automatically be added to the database by the helper function in src/webserver.js. +2. Log in as a user and create a new post. Then select the "Homework" or "Assignment" tag for the message depending on the forum or category. +3. Log in as a TA and navigate to the course forum. Use the filtering options to view only posts tagged with "Homework" or "Assignment." +4. Filter posts tagged with "Homework" and answer all related questions before switching to the "Assignment" tag filter. This helps streamline responses by focusing on one topic at a time. +5. Check that filtering by tag shows only the relevant posts and that switching between "Homework" and "Assignment" tags allows you to effectively manage the posts. + +### Automated Tests - located in `test/notifications.js` +* Location: Automated tests are located in test/werbserver.js +* Error Tests: Test for invalid forum categories +* Valid Tests: Ensure that "Homework" and "Assignment" tags are correctly added and present in the database. + +#### Test Justification +We believe these tests are sufficient because they verify that the tags are automatically added and can be used effectively for filtering, ensuring that TAs can quickly navigate posts based on topic. + ## User Story 7 As a student, I want to save posts to favorites for posts that contains important information/good solutions, so that I can review them later on quickly