Documentation Plan

For our project we worked on Shift Overflow this semester. There are two different types of users: Learning Assistants and Administrators.The Learning assistant will use the interface to access and request changes to their schedules while the administrator will use it to make changes and view the schedules made by the scheduling algorithm itself. 

1. User Documentation:

a. General Public Users:

  • Documentation Level:
    • Aim for simplicity and clarity suitable for users of all skill levels.
    • Emphasize a self-explanatory user interface.
  • Media and Mechanisms:
    • FAQ Section:
      • Include a dedicated FAQ section for quick problem resolution.

2. Administrator Documentation:

a. Administrator (Alyssa):

  • Skill Level:
    • Assume students and professors as users with varying technical competencies.
  • Media and Mechanisms:
    • Video:
      • Create videos guiding administrators on Gitlab navigation and repository cloning.
    • README.md:
      • Include a high-level overview of webite functionality.
      • Provide links to the Admin manual.
    • Admin Manual:
      • Installation:
        • Detailed instructions for installation on Windows and macOS.
        • Terminal commands for setup.
      • Codebase Overview:
        • Break down the codebase by functionality.
        • Reference specific files for authentication and other purposes.
        • Account Access:
          • Provide ownership details for Gitlab, and Carolina cloud apps.
        • Handoff Plan:
          • Clearly outline the handoff process, including access to Gitlab, and the hosted website
        • Set Up Locally:
          • Step-by-step guide on cloning the repository into Visual Studio Code.
          • Instructions on running and updating the codebase.

3. Video Documentation:

a. Video Creation:

  • Video Types:
    • Short, focused videos addressing Gitlab navigation, repository cloning.
    • Multiple videos for specific scenarios, providing step-by-step guidance.
  • Production Tool:
    • Use Zoom for team recording and screen sharing for effective demos.
  • Distribution:
    • Host videos on the project website and email video links to the client during the handoff.