Documentation Plan

User Documentation

• Purpose and value of app

  • Shown through text on home page

    • Clearly shown when the app is first opened so that users can easily understand the purpose, motivations, and usefulness of the app

• Feature explanations

  • Shown through text on home page and at the top of each feature's page

    • Clearly shown when the app and each feature are opened so that users know what the different features of the app are and how to interact with them

• Error information

  • Shown through red error messages that appear on the page when an error occurs

    • Clearly shown in the case of an error to let the user know what they should do to resolve it so that the app can resume normal functionality

Administrator Documentation

• Software and hardware dependencies

• System testing

• Compatibilities and incompatibilities

• Redeployment/restart instructions

• Database management instructions

  • All of the above are in an admin manual document in the shared folder

    • Easily accessible to admin whenever they need to reference it