Author Information
- Authors: Yaser Deeb
- Team: OnTrack - Task View and Submission Redesign
- Team Delivery Lead: Yaser Deeb
Document Summary
Section titled “Document Summary”- Documentation Title: Epic Document
- Documentation Type: Technical
- Documentation Information Summary: Critical links and resources; the background, context, and business value of the project; and the acceptance criteria.
Document Review Information
Section titled “Document Review Information”- Date of modified Document Submission to GitHub: 15/05/2023
- Documentation Version: 3.0
- Date of Previous Documentation Review: 22/09/2022
- Date of Next Documentation Review: T2/2023
Key Terms
Section titled “Key Terms”Trello: A web-based list-making application designed with a focus on teams that implement a scrum style of organisation.
Figma: A web-based application for user interface and user experience design.
UI: User Interface; the means by which a human interacts with a machine, these are typically graphical interfaces that accept input from an end-user.
UX: User Experience; all aspects of the end-user’s interactions with an application or device.
Flow: A frame-by-frame image of a user (a student, tutor, convenor, or administrator) performing a necessary function from beginning to end. Flows allow designers to think critically about how the usability of a design. It may save the project from investing time and resources into unusable dead-ends.
Key Links/Resources
Section titled “Key Links/Resources”- T1/2023 Trello Board
- OnTrack Overseer Repository
- OnTrack Web Repository
- OnTrack API Repository
- thoth-tech/ChatHistoryDisplayer
- T3/2022 Delivery Lead’s ChatHistoryDisplayer
- T1/2023 Figma
Contacts for further information
Section titled “Contacts for further information”Related Documents
Section titled “Related Documents”View Task and Submission Epic Document
Section titled “View Task and Submission Epic Document”Background / Context
Section titled “Background / Context”OnTrack is employed by multiple institutions as a learning management system. The View Task and Submission project intends to create user-centric modifications to existing features, addition of new features to the task submission and view in the OnTrack platform.
Business Value
Section titled “Business Value”By further modernising OnTrack, institutions can deploy the OnTrack platform to satisfy the needs of their students, markers, assessors, and auditors. The platform can support all stakeholders to fulfil their obligations and, in the case of the student, support the learning of essential concepts. By streamlining the experience of markers, then associated costs may decrease. Additionally, the feedback loop for students (the learning feedback loop) may shorten.
In Scope
Section titled “In Scope”- Design planning and documentation
- Removal of redundant features
- Modification of existing features
- Addition of new features
- Task view for students
- Task submission for students
- Task view for markers
- Front-end
- Back-end
- Security
- Database
Out of Scope
Section titled “Out of Scope”- Visual flavour
- Logo
UI/UX Considerations
Section titled “UI/UX Considerations”- Navigability
- Can all features be navigated to?
- New features?
- Previous features that were retained?
- Navigability can be gauged by the creation of multiple flows.
- Can all features be navigated to?
- Accessibility
Regulation & Compliance Considerations
Section titled “Regulation & Compliance Considerations”- Storage and privacy of user’s data.
- Security
- Retention policy.
Operations / Support / Training Considerations
Section titled “Operations / Support / Training Considerations”Team members may require training/up-skilling in applications, technologies, and languages, such as:
- git
- GitHub,
- Figma,
- Docker,
- Ruby,
- Ruby on Rails,
- Python,
- TypeScript,
- Bootstrap,
- Angular,
- Sinatra,
- React,
- MUI.
Team members must express testing skills by use of various testing tools to ensure functionalitie work as intended. They also must be able to fix and/or document and report on issues or bugs as they arise.
Acceptance Criteria
Section titled “Acceptance Criteria”- Managing director must approve of the design before implementation.
- If a change is required, then an alteration to the design (with approval from the managine director) must be completed first.
- All code must be tested before an attempt to pull into the upstream repositories.