D4. User Manual

Ensuring all users of the system have access to the the information that they need to run the system and gain benefit from it.

Documentation Plan

Users

  • Daisy Dietician (Regular End User): Daisy is a registered health care professional, (e.g registered dietician, dietician technician, advanced practice provider, nurse, or physician). She will use the Nutrient Needs calculator for pediatric patients, the Formula Look-Up for specific product types and brands, and the Formula Calculator to build custom formula mixes.
  • Alex Admin (Admin User): Alex is a database administrator and will interact with the frontend to add new formula products with nutritional data to the database and edit existing products. Alex cannot access superuser-only features.
  • Sally Superuser (System Administrator): Sally is the system administrator and will use the frontend to add and edit formulas, review and approve pending formulas, and bulk activate and deactivate multiple formulas at once in the database.

Documentation Daisy Dietician Will Need

  • User Manual: Covering how to create an account, change password, use the Nutrient Needs Calculator, use the Formula Look-Up, use the Formula Calculator, and print results
  • FAQ topics, including: editing/deleting an account, privacy concerns, and requesting admin permissions.

Documentation Alex Admin Will Need

  • User Manual: Covering how to create an account, view the admin panel, add product information, and edit product information
  • FAQ topics, including: how to correctly enter product information and privacy concerns

Documentation Sally Superuser Will Need

  • User Manual: Covering how to create an account, view the admin panel, add product information, edit product information, approve a product, activate/deactivate a product, use filtering, bulk-editing, and sorting functionality, download data from table, and get user emails
  • FAQ topics, including: how to grant users admin permissions and privacy concerns
  • Administration Documentation, including: accessing the GitHub code repository, accessing/editing the database in Supabase, and accessing the deployed site on Vercel

How We Will Provide Documentation

  • User Manuals: Will be provided as dedicated pages within the web app through this link and available as downloadable PDFs. This approach allows users—especially clinicians who may have limited time—to access instructions directly while using the tool. PDFs provide an offline option and ensure portability. Because user familiarity with technology may vary widely, manuals will use clear, non-technical language and include screenshots, diagrams, and step-by-step examples. FAQs will be provided by the client.
  • ReadMe File (System Setup & Maintenance) : All developer-level and administrator-level technical information (setup, configuration, deployment, environment variables, database structure) will be documented in the project’s GitHub README. The README is the conventional and most accessible location for system setup instructions for future developers or client technical staff. It ensures long-term maintainability and version control.
  • Tutorial Videos: Will be provided as short video tutorials for end users demonstrating how to access the app and use major features. Videos will be embedded in the web app. We will also provide technical walkthrough videos for the client demonstrating how to access, set up, and manage system components. Videos will be sent to the client via email and linked on our team website. Videos support visual learners, reduce onboarding time, and help users with limited technical experience follow workflows more confidently. These videos will be linked in the Client Handoff Document.