Documentation Plan
Users Manual:
The main users will mainly consist of the Surgeons and Patients but can include the Adminstrator. The user Manual will be put on github ReadMe file and will be dedicated to:
- How to Install the APK on to the VR headset.
- How to load tests on to the VR headset.
- How different controls are setup to interact with the application. Such as the remote controls, keyboard, and bluetooth foot pedals.
Adminstrator Manual:
The Adminstrator manual will consist of any documentations on how the project works and tools to further develop it. This will also be put on put on to Github:
- How to pull the code from the repository.
- How to edit, build, and run the project in Unity.
- How to produce the APK file to load onto the headset.
- Information regarding the CardController script and its functionality.
- Information regarding the ColorTestCanvas script and its functionality.
- How to use the ADB to debug the application
- How to structure the Test files to be loaded on to the headset
- It will have information in regards to package versioning.
- How to add new developers to the existing repository