D4. User Manual

User Documentation

  • Users
    • Person with food allergies
  • Public Documentation
    • Initial Introduction Screen
      • Explanation on purpose of SafeEats
      • Guide on current pages available for navigation and functionalities
    • Help Screen
      • Guide on current pages available for navigation and functionalities
      • FAQ section to answer (predicted) common and basic questions

Admin Documentation

  • Admin
    • Client
    • Future Developers
  • Private Documentation*
    • Set-up Manual
      • Required installations and environment set-up
      • Overviews
        • Github
        • Firebase (connection, authentication, real-time database)
        • VS Code and Expo Go
        • Android Studio and iOS Simulator
    • ReadMe Files
      • Brief overview of installations and set-up
      • Available features in SafeEats so far
    • Code Comments
      • Description of each file’s purpose and functionalities

*Adapted from previous team’s documentation