3. Software Requirements - nus-mtp/sashimi-note GitHub Wiki

The Goal of the Project

To provide a flexible and extensible document viewing and editing platform that can be used in class (during lecture) and out of class (revision) to allow lecturers to provide a more effective and comfortable learning experience to students, so that students can learn more effectively.

Requirement Gathering Process

This section records the process of how we have gathered feedback, opinions and suggestions for the formulation of our project requirements. As students ourselves, we have constant close interaction with NUS students in our daily school life, as such our team decided on drafting preliminary user stories for students and documented them here. Next, we proceeded to gather students' feedback through observations and word of mouth before evaluating and refining the finalised user stories to generate students' requirements for our product. However, our unfamiliarity with lecturers'/professors' difficulties and views resulted in problems drafting accurate and important requirements for them as users of our product.

  1. Interviews
  2. Field Observations
  3. Word of mouth

1. Interviews

To tackle the aforementioned problem relating to lecturers and professors, we decided to set up interviews with some NUS professors and students to learn about their difficulties in creating lecture notes, slides, course materials, and document editing/viewing. Below are questions used for the interviews.

1.1 Questions

To understand the nature of the content they are teaching

  1. What modules are you currently teaching?

To understand the technology they are using

  1. What are the tools you use to create your notes or presentation slides?
    • What do you like about the current tools that you are using?
    • Are there any limitations to these tools?
  2. What are the contents inside your slides?
    • Do you use a lot of graphics, text or a mixture of both in your slides?
  3. Which aspect of the creation part is most time consuming?
    • Is animation a feature you use often?
  4. Is there anything you wish that could be added into your existing tool to help you with doing the task?
  5. Do you use LaTeX, markdown or other similar tools to create your document instead of PowerPoint? Why is it so?
  6. Do you conduct e-learning lesson or tutorial during e-learning week?
    • What tool(s) do you use for conducting the lessons?
    • How was the experience with using such tool(s)?
    • What do you think can be improved about the tool(s)?

End of Interview

  1. Could our proposed product be useful to you?

1.2 Results

A summary of the interviewing results are documented here.
Below are some of the highlights:

1.2.1 Tools used to create lecture materials
  1. PowerPoint
  2. LaTeX with Beamer
  3. Jupyter
  4. PowerPoint Labs
  5. PeerQuestions by CIT NUS for Live Lecture SMS feedback feature
1.2.2 Pain points
  1. It is time consuming to prepare and maintain multiple versions of the documents with different content to show
  2. User has limited capability when using LaTeX and Beamer to create slides with many virtualization
  3. It is tedious workflow having to draw diagrams externally before inserting into LaTeX document
  4. It is tedious workflow having to create mathematical symbols and code externally before inserting into PowerPoint slides
  5. User may prefer to stick with tools and technology that they are already familiar with
  6. Creating animations in PowerPoint slides take a lot of effort and steps

2. Field Observations

Our team made use of our lecture time to observe and understand more about how students are coping with the current lecture and documentation formats. Below are the observations we have noted down:

2.1 Student Behaviour

During lectures, students liked to:

  • refer to a digital copy of the lecture notes only (using phones/laptop/tablet)
  • refer to a digital copy of the lecture notes and annotate using third-party software (using phones/laptop/tablet)
  • refer to a digital copy of the lecture notes along with a hard copy for writing down notes
  • refer to a digital copy of the lecture notes along with foolscap/notebook for note taking
  • refer to a printed copy of the lecture notes and write directly on it

2.2 Pain points

Problems/Difficulties students faced:

  • Handwritten annotation only limited to those with tablets/laptops supporting stylus
  • Error-prone process for printing the correct format/pages (e.g. sometimes prints slides instead of the note format)
  • During some lectures that does not use PeerQuestions, it is hard/difficult for a student to have his doubts clarified
  • Technical difficulties in recording lectures result in static and muffled sounds in webcast or no webcast at all, students find it hard to revise/revisit lessons should they not understand parts of the lecture or are absent for valid reasons

3. Word Of Mouth

In addition to our Field Observations, friends and relatives of our team members have also provided some inputs on some of their problems faced with the current lecture and documentation format. Below are their inputs:

  1. Annotation features lacking.
  • Annotation requires third-party apps (paid and free) and do not have lecturer's annotations
  • Students whose laptop do not support touchscreen or stylus have to resort to typing out instead of writing
  • This seems to be a popular problem students face, many solve it through printing out the notes and writing on it
  • However, those without printers or exhausted their print quota have to live with it.
  1. Printing formats.
  • Some lecture slides use dark background and are almost impossible to print as printer fails to convert the changes made, and just prints the original copy (printer ink is wasted, content hard to see on printed paper)

Requirements

  1. Functional requirements
  2. Non-functional requirements
  3. Abuser Stories
⚠️ **GitHub.com Fallback** ⚠️