Skip to content

Latest commit

 

History

History
227 lines (140 loc) · 6.73 KB

Function-Specification.md

File metadata and controls

227 lines (140 loc) · 6.73 KB
Raw

UCLCSSA WeChat App Functional Specification

Terminology

This specification uses the terms MUST, SHOULD, MAY, MUST NOT, MAY NOT, SHOULD NOT, RECOMMENDED, OPTIONAL, REQUIRED, SHALL as defined in RFC2119.

We use the following terminology to specify the user states:

Terminology Definition
UCL University College London.
WECHAT LOGIN User is logged in via WeChat API.
UCL LOGIN User is logged in via UCL API.
GUEST User is neither logged in via WeChat nor UCL API.
LOCAL TIMEZONE The timezone where UCL is located. Note the the timezone needs to take into account Daylight Savings adjustments.
LOCAL CITY London.
CSSA UCL Chinese Students and Scholars Association.
ADMIN Administrator
CSSA-CARD Discount card published by UCL CSSA.

Functional Requirements

1. Main Page

Main Page Screenshot 1

1.1 Weather and Date

This part should contain:

  1. Date. Use LOCAL TIMEZONE.
  2. Weather. Use weather for LOCAL CITY.
1.1.1 Weather Description

Required elements:

  • Weather
  • Highest Temperature (Degrees Celsius)
  • Lowest Temperature (Degrees Celsius)
  • Recommended clothing

1.2 Events

Events are displayed inside a horizontal slider:

  • Auto-scroll is enabled on the slider, with animation time set to 2 seconds.
1.2.1 Content
  • Events cards MUST contain CSSA activities.
  • MAY contain other information.
1.2.2 Horizontal Slider
  • Horizontal Slider SHOULD display preview images.
  • Each preview image represents an article.
1.2.3 When User tap picture on the horizontal slider

Full news article SHOULD be displayed on a new page.

1.3 Personal Timetable

TODO: What happens if the user is not yet logged in?

The personal time table contains two components:

  1. Horizontal slider which displays today's lecture(s).
  2. Show Full Timetable button ("显示完整课表").

Each lecture is displayed inside a block which represents a time slot (c.f. outlook calendar events).

It is REQUIRED that the horizontal slider only moves when the user scrolls it.

1.3.1 Block

Each block SHOULD include following information:

  1. Start and End Times.
  2. Event Location(s) (Building, Room).
  3. Relevant Participant Name(s) (Lecturer's name in case of a Lecture event).
  4. Event Type, one of:
    1. Lecture
    2. Problem-based Learning
    3. Discussion
    4. Tutorial
1.3.2 Button

TODO: Pending design.

1.4 Library Seats

  • A block that displays available seats for each library.
  • The information for each library MUST be displayed as progress bars.
1.4.1 Progress bar
  • A progress bar represents the number of empty seats.
    • When there are no seats:
      • Progress bar is full.
    • When there are available seats:
      • Progress bar shows proportion of available seats versus total seats.
    • The color of the bar represents how busy each library is.
    • The actual number of available seats MUST be displayed next to the bar.
    • The user MAY press each progress bar if he/she wants to see more information about the corresponding library.
1.4.2 Color

The color of the progress bar MUST indicate the availability of each library:

Color Meaning
GREEN 💚 Proportion of empty seats is above or equal to 70%.
YELLOW 💛 Proportion of empty seats is less than 50%.
ORANGE 🔶 Proportion of empty seats is less than 30%.
RED 🔴 Proportion of empty seats is less than 15%.
1.4.3 Number Display
  • The proportion of available seats and the number of available seats MUST be displayed.
1.4.4 Library Displayed

The most popular libraries or study facilities that MUST be displayed:

  • Main library
  • Science library
  • Student Centre
  • IOE library

The user SHOULD be able to choose his/her favorite study facility (i.e. pin it).

1.4.5 Tapping progress bar

Jump to library seats page.

TODO: Jump to library seats page. TODO: Pending Design.

2. Post Page

Post Page Screenshot 1

2.1 Post Horizontal Slider

User MAY post information of different categories.
The categories MUST include:

  • 房屋出租
  • 二手闲置
  • 提问回答
  • 失物招领
2.1.1 Interact with user

  • It is REQUIRED that the horizontal slider only moves when the user scrolls it.

  • When user press specific section, that section should be highlighted as shown in the design and the posts displayed should be filtered.

2.2 Post Block

Each post inside each category page SHALL be displayed as a post block. A post block should include the following elements:

  • Time
  • Title
  • Brief content
  • User Information
  • Photo
2.2.1 Time

LOCAL TIMEZONE

2.2.2 Title

TODO: Discuss how many characters Title should include?

2.2.3 Brief Content

TODO: Discuss how many characters Brief Content should include?

2.2.4 Photo

TODO: Discuss photo size and other photo-related specifications.

No more than 3 photos.

2.2.5 User Information

User Profile and ID.

2.3 Post Button[WECHAT LOGIN REQUIRED]

TODO: Pending design.

3. Restaurant Page

Restaurant Page Screenshot 1

3.1 CSSA CARD(Wechat Login)

When pressed, display the CSSA-CARD.

3.2 Restaurant Block

Restaurant Block should include following elements

  • Name of restaurant
  • Photo of restaurant

3.3 Restaurant Filter

TODO: Pending design.

3.4 Restaurant Search

TODO: Pending design.

4. MyUCL Page