Repository navigation
docs: add design document #133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
sean-dickinson
wants to merge
2
commits into
main
Choose a base branch
from
design-document
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # EndsideOut LMS Design Document | ||
|
|
||
| ## Goals | ||
|
|
||
| This system aims to provide EndsideOut a custom Learning Management System to: | ||
| - Streamline their existing in-person delivery of health and wellness educational content to the students | ||
| - Provide a centralized platform for managing the data they used to track learning outcomes, so they can generate reports needed to provide to their funders | ||
| - Grow their ability to reach more individuals by providing a platform for asynchronous learning and engagement so they are not limited by their ability to staff and travel to deliver content in person | ||
|
|
||
| ## Context | ||
|
|
||
| ### Why a custom platform? | ||
| - EndsideOut initially attempted to use an off the shelf LMS, but found that it did not work well for their audience's needs and did not provide the flexibility they needed to manage their content and track learning outcomes. | ||
| - Too complex for students with low literacy | ||
| - Too complex for an in person delivery model | ||
| - Too complex for using with students without email accounts | ||
| - Too many features that were not needed for their use case, which made it difficult to use and maintain | ||
| - EndsideOut has a technical team that wants to be able to deeply integrate existing custom games and other content into the LMS | ||
| - EndsideOut wants to grow their ability to reach more individuals by providing a platform for asynchronous learning and engagement, while also supporting their current in-person delivery of health and wellness educational content to the students. | ||
|
sean-dickinson marked this conversation as resolved.
Outdated
|
||
| - EndsideOut needs the platform to meet a high standard of accessibility and usability for their audience, which includes individuals with varying levels of technical proficiency and English language skills. | ||
|
|
||
| ### MVP Requirements | ||
| #### Student Experience | ||
| - The platform must make it easy to students to login and access content. Example constaints include: | ||
| - A student may not have an email account | ||
| - A student may not be able to read or type a url given to them | ||
| - A student may not be able to read or type (or remember) a password given to them | ||
| - A student may only have access to a school provided device, such as a chromebook | ||
| - All content on the platform must be accessible to students with varying levels of technical proficiency and English language skills. | ||
| - Content should be offered in multiple languages, including Spanish and English | ||
| - Text content should have the option to hear it spoken aloud | ||
| - A student should be able to access the content for their enrolled program, including past content. | ||
|
sean-dickinson marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### Administrator Experience | ||
| - The platform must allow administrators to create and manage their programs by school | ||
|
sean-dickinson marked this conversation as resolved.
|
||
| - The platform should allow pre-registering students for a program by school, and then allowing them to log in and access the content for that program | ||
| - The platform should allow administrators to create and manage content for their programs, including the ability to upload and organize content | ||
| - The platform should allow administrators to track student progress and learning outcomes, including the ability to generate aggregate reports on learning outcomes by school, program, and grade level. | ||
|
sean-dickinson marked this conversation as resolved.
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i notice this bullet was already part of the Goals section, i think it could be left off here