D4. User Manual – Documentation Plan

Users:

The intended users of Buckner University are Buckner employees who will be completing company required training programs. We also expect developers and administrators to work with the project for future development and maintenance. We will write documentation of what a general user can do when they are on the home screen and what they will need in order to get an account.

Administrator Documentation:

For administrators who plan to oversee progressive development of this project, we will guide our client through the set-up process detailed in our readme. We will also provide detailed documentation of the project’s overall development, this will include:

• A description of the project’s varying aspects:
  • Architectural design
  • Data pipelines
  • User workflow
• Detailed code comments and test cases

Having this documentation will enable administrators to maintain the project’s high-quality standards in future development by providing them with design context.

Developer Documentation:

We will write out robust documentation on both the backend and frontend to allow other developers to pick up where we left off. This documentation will be stored in the README file in our GitHub repository. Additionally, our code is well commented and contains error checking to ensure easy development in the future.

Documentation will include:

• API endpoint write up
  • What endpoints are included in our backend
  • Parameters for each endpoint
• Description of workflows
• Explanation of calls to ITI, OpenID, and SalesForce
• Architecture diagram 
• List of external libraries and npm packages to install
• Code comments will be included throughout the project with the intention of giving a description of what each method or class is performing.

Having this documentation will enable developers to contribute in ways that align with code quality standards of the existing project, ensuring project architecture is maintained for future scalability.