D4. User Manual

The Documentation Plan

Users

• Children of all ages

• Adults learning/teaching about cyberbullying mitigation and prevention

• Anyone that wants to access the game

Documentation

• Manual - Framework for how to download and set up the game given your OS

  • This is helpful for adults setting up the game, as well as teachers or parents helping children to set up the game.

• Text on screens

  • This is more so aimed for the children, to help guide them through the game

• Tooltips

  • This assists children and adults, these are generally helpful in any game

User Documentation

User Manual

The User documentation is meant for our users.

Documentation

• User Instructions

  • Ideally, this app will be able to be downloaded via Apple's app store and Android's play store

  • Upon opening the application, the user will be able to access a FAQ's page

• FAQ's

  • This page will cover commonly asked questions

• Game Instructions

  • • Each game will have an initial instructions screen

    • This is more so aimed for the children, to help guide them through the game

• Tooltips

  • • This assists children and adults, these are generally helpful in any game

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

  • Will include links of necessary tutorials we found helpful

  • Will list out features we've implemented

• Code Comments

  • Important methods found in the scripts will have comments describing what it does

  • Scenes will be named approperately based on what they are for

  • Elements/nodes in the scenes will be named based on function 

Video: https://youtu.be/CklrWJ9dkhw