D4. User Manual – Documentation Plan

User Documentation

Users

The main users will be high school students who have faced or are facing cyberbullying, as well as high school students who wish to learn more about identifying and preventing cyberbullying.

Other users include:

  • Individuals who are interested in cyberbullying mitigation and prevention
  • Teachers who want to learn more about cyberbullying mitigation and prevention
  • Parents whose children use social media and other technologies

Documentation

  • Manuals
    • Include descriptions of how to navigate the game

How To Set Up Framework/Environment And Clone Repository To Local Computer

Admin Documentation

Admin Manual

The admin documentation is meant for our client. We will be sending our documentation to this client, but it is probable that there will be people in the future that will maintain and continue developing the game.

Documentation

  • Admin Manual
    • Includes a complete description of the project
    • Includes code maintenance documentation
  • ReadMe Files
    • The client will be receiving the project’s GitHub Repository
    • The file will provide a description of how to download and setup Godot, as well as instructions for how to run the code and tests
    • Will list out important sections of the code
    • There will be links to relevant official documentation
  • Code Comments
    • Important methods found in the scripts will have comments describing what it does