Skip to content

Expand & Improve User Guide with Detailed Feature Explanations and Screenshots #12

Description

@shadil-rayyan

The current User Guide (app/user-guide/page.tsx) provides only a very brief overview of app features.
This is not sufficient for new users, especially first-year students and non-technical users.

We need to expand the User Guide with clearer explanations, step-by-step usage, and optional visuals.


Current Problems

  • User guide is too short and high-level

  • Most features are explained in 1–2 lines only

  • No screenshots or visual guidance

  • Users do not understand:

    • How to actually use each feature
    • What data is stored locally vs externally
    • What is safe to use and what redirects outside the app

Proposed Improvements

1. Expand Each Feature Section

For every major feature, add:

  • What the feature is for
  • How to use it (basic steps)
  • Any limitations or notes

Example:

  • Timetable Viewer: upload, view, replace
  • Attendance: local-only storage, manual entry
  • Finance Tracker: personal data stays on device
  • Bus Timings: college vs private buses
  • Clubs: informational only, links may change

2. Add Visual Aids (Optional but Recommended)

  • Add screenshots or icons for:

    • Home page
    • Sidebar
    • Key features (Bus, Attendance, Finance, Clubs)
  • Images should support the text, not replace it


3. Improve Structure & Readability

  • Group features into sections:

    • Academic Tools
    • Utilities
    • Community & Resources
  • Use clearer headings and spacing

  • Keep language simple and student-friendly


Acceptance Criteria

  • User Guide content is significantly expanded
  • Each major feature has a clear explanation
  • Basic usage steps are included
  • Optional screenshots added (if available)
  • Page remains readable on mobile
  • No breaking changes to routing or layout

Why This Change Is Needed

  • Helps first-time users understand the app
  • Reduces confusion and repeated questions
  • Makes the app feel more complete and polished
  • Improves onboarding without adding backend logic

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions