Skip to content

Latest commit

 

History

History
117 lines (64 loc) · 4.98 KB

UserGuide.md

File metadata and controls

117 lines (64 loc) · 4.98 KB

User Guide

Introduction

This guide explains how to use new features in NodeBB, including anonymous posting and private posts for instructors. It provides step-by-step instructions for users and covers automated testing to ensure reliability.


How to Use the New Features

Posting Anonymously

Logging In

Users need to log in to their NodeBB account.

Posting as Anonymous

When creating a new post or replying to a thread, there is an option to post anonymously. This option is a checkbox in the post creation interface.

Posting Content

Users can write their post or reply as they normally would but with the anonymity option enabled.

Submitting the Post

After composing the post, the user should click the "Submit" button to publish it anonymously.

After Submission

Users can edit the post’s anonymity by selecting the edit option on their post after posting.

Viewing the Post

The post is visible to the instructor with the user's name, while other students will see it as anonymous.


Posting Privately for Instructors

Logging In

Users need to log in to their NodeBB account.

Posting Privately for Instructors

When creating a new post or replying to a thread, there is an option to post privately for instructors. This option is a checkbox in the post creation interface, labeled as "Post Privately"

Posting Content

Users can write their post or reply as they normally would, with the "Post Privately" option enabled.

Submitting the Post

After composing the post, the user should click the "Submit" button to publish it privately for instructors.

Viewing the Post

The post is visible to the instructor with the user's name associated with it. Other students or users will not have access to this post; it remains hidden from their view.


Automated Testing

Automated testing is crucial for ensuring the reliability of these features. It helps catch errors and ensures that new code changes don't break existing functionality. Here are some automated tests our team has considered for our new features:

  • Unit Tests: Write unit tests for individual functions or methods responsible for enabling anonymous posting and handling private messages. These tests should cover different scenarios, including edge cases.

  • Made Sure Existing Functionality: Ensure that existing functionality (e.g., regular posting and messaging) is still working as expected after implementing these new features.


Manual Testing by the Team

Manual testing was also conducted by all team members following the steps below to ensure full functionalit of previous version of NodeBB and the implementation of the new features.

Scenario-based Testing

For Anonymous Posting

Instructors:

  1. Log in with their Instructor accounts.
  2. Enable anonymous posting.
  3. Create test posts.
  4. Verify that student name is visible but hidden from public view.

Students:

  1. Log in with their Student accounts.
  2. Enable anonymous posting.
  3. Create test posts.
  4. Verify that their name is hidden from other students but visible to the instructor.

For Posting Privately for Instructors

Instructors and Students:

  1. Log in with their respective accounts.
  2. Enable the "Post Privately" option.
  3. Create test posts.
  4. Verify that these posts are visible to the instructor with the user's name.
  5. Confirm that other students or users cannot access or view these private posts.