Skip to content
Permalink
Browse files

readme changes

  • Loading branch information...
profmikegreene committed Nov 1, 2018
1 parent 63beed5 commit f3c96d4fde2150ee183cd06e3e37dd6316e5c9f1
Showing with 46 additions and 56 deletions.
  1. +3 −1 CONTRIBUTING.md
  2. BIN docs/_assets/kits-concept-diagram.png
  3. +43 −55 readme.md
@@ -1,4 +1,6 @@
# How to contribute to this project

Comment on issues. Add to the discussion, help flesh out user stories, add assumptions we haven't realized.
The quickest, easiest way to contribute is to comment on issues. Add to the discussion, help flesh out user stories, add assumptions we haven't realized.

As of this writing, Kits is a Duke University project, but we're looking for other institutional partners interested in collaborating deeply with us. Reach out to michael.greene@duke.edu if your interested in partnership.

Binary file not shown.
@@ -1,82 +1,70 @@
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
[![Documentation](https://img.shields.io/badge/documentation-github.io-28a745.svg)](https://dukelearninginnovation.github.io/learn.duke/)
[![UXPin](https://img.shields.io/badge/mockup-uxpin-006cff.svg)](https://preview.uxpin.com/97f1536f1e1180fb99f4e5e05651cf146eef0747#/pages/85694982/simulate/sitemap)
[![InvisionApp](https://img.shields.io/badge/art%20style-invisionapp-FF2C5B.svg)](https://projects.invisionapp.com/boards/7B3NU02UC4M/)
[![Components](https://img.shields.io/badge/components-patternlab-ff69b4.svg)](https://toolkits.webservices.duke.edu/?p=all)
[![GitHub license](https://img.shields.io/github/license/DukeLearningInnovation/learn.duke.svg)](https://github.com/DukeLearningInnovation/learn.duke)

# Kits

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Documentation](https://img.shields.io/badge/documentation-github.io-28a745.svg)](https://dukelearninginnovation.github.io/kits/)
[![UXPin](https://img.shields.io/badge/mockup-uxpin-006cff.svg)](https://preview.uxpin.com/97f1536f1e1180fb99f4e5e05651cf146eef0747#/pages/85694982/simulate/sitemap)
[![InvisionApp](https://img.shields.io/badge/art%20style-invisionapp-FF2C5B.svg)](https://projects.invisionapp.com/boards/7B3NU02UC4M)
[![GitHub license](https://img.shields.io/github/license/DukeLearningInnovation/kits.svg)](https://github.com/DukeLearningInnovation/kits)

## Scope

Kits is an effort to bring [NGDLE](//ngdle.org) into our faculty and student reality here at Duke, an attempt at creating the ideal learning technology future for our users in a lean way.
Kits is an effort to modernize the learning technology ecosystem around [NGDLE](//ngdle.org) concepts.

The problem statement and questions below drive [MVP1](https://github.com/DukeLearningInnovation/learn.duke/milestone/1) and are prioritized above the rest of the project.
The current state of Learning Technologies has focused primarily on meeting faculty's teaching needs through the Learning Management System.

The scope of Kits is on courses for MVP1 with a variety of learning opportunities supported at a later date.
This contradicts our vision of the ideal university IT and academic culture. A culture of technological plurality and choice.

Kits is an open source project [licensed under the GPL v3](LICENSE.md).
For university IT, relying on any single solution, including the LMS, is a short-sighted strategy that provides suboptimal learning experience as a monolithic system cannot provide the best learning experience for all aspects of all learning communities.

The best learning happens when appropriate apps are used in conjunction with active learning pedagogies.

### [#83 Problem Statement 1](https://github.com/DukeLearningInnovation/learn.duke/issues/83)
## How Kits Works

The current state of Learning Technologies has focused primarily on meeting faculty's teaching needs through the Learning Management System.
For faculty, Kits allows them to start with the official roster of students and add folks like teaching assistants, collaborating faculty, support staff, or librarians, creating a group.

We see the ideal university IT and academic culture as one of technological plurality and choice, not a single, forced enterprise option.
Faculty then turn on the apps they want to use with this group, and Kits gives everyone appropriate access to all the apps at once.

For university IT, relying on any single solution, including the LMS, is a short-sighted strategy that provides suboptimal learning experience as a monolithic system cannot provide the best learning experience for all aspects of all learning communities.
This combination of group + apps is called a kit.

The best learning happens when appropriate apps are used in conjunction with active learning pedagogies.
We're starting with courses, but the kit concept can be applied to all learning experiences someone might encounter with a university.

What Toolkits and the Learning Management System fail to address is a solid user experience for managing the cognitive load of selecting and using multiple apps for learning through a semester.
![Kits Concept Diagram](docs/_assets/kits-concept-diagram.png)

Kits will initially address this gap by
### Project Goals

* providing students a unified interface for accessing the apps used by their learning communities
* providing faculty a catalog of learning technologies for use in their learning communities
* allowing faculty to manage the people in and tech of their learning communities.
* providing information on learning technology management and policies.
1. Provide students a unified interface for accessing the apps used by their kits
1. Provide faculty a catalogue of learning technologies for use in their kits
1. Allow faculty to manage membership of and technologies used by their kits
1. Provide information on learning technology management and policies.

# Terms
Term | Our definition | | |
-----|---------------|---|---
Learning community | Functionally, for the time being, a course. Technically, a context that ties a Grouper group for a roster + guests to apps used by that group.
App | A technology used by a learning community in the context of learning that is listed in /apps. Not limited to enterprise licensed technologies. School, departmental, and unlicensed apps will also be listed.
Ecosystem | All of the integrated technologies used for learning at Duke. Shortened synonym for Learning Technology Ecosystem. | |
User story| "As a *who*, I want *goal* so that *reasons*". These are the specification for design and development work. Acceptance criteria written in Gerkin These are tracked via a Github Label. | [All User Stories](https://github.com/DukeLearningInnovation/learn.duke/issues?q=is%3Aopen+is%3Aissue+label%3A%22user+story%22) | [![Add User Story](https://img.shields.io/badge/Add-User%20Story-green.svg)](https://github.com/DukeLearningInnovation/learn.duke/issues/new?template=user_story.md&labels=user%20story)
Assumption | Unknowns that require further discussion, user research, or development iterations to be known. These are tracked via a Github Label. | [All Assumptions](https://github.com/DukeLearningInnovation/learn.duke/issues?q=is%3Aopen+is%3Aissue+label%3Aassumption) | [![Add User Story](https://img.shields.io/badge/Add-Assumption-green.svg)](https://github.com/DukeLearningInnovation/learn.duke/issues/new?labels=assumption)
Hypothesis | A question used to drive design and development deliverables that can be tested in order to learn. Help explicitly state assumptions related to user stores. These are tracked via a Github Label. | [All Hypothesis](https://github.com/DukeLearningInnovation/learn.duke/issues?q=is%3Aopen+is%3Aissue+label%3Ahypothesis) | [![Add Hypothesis](https://img.shields.io/badge/Add-Assumption-green.svg)](https://github.com/DukeLearningInnovation/learn.duke/issues/new?labels=hypothesis)
MVP | The minimum viable piece/thing/product/idea/design we can build to validate or invalidate a hypothesis. These are tracked via Github Milestones. | [All MVP](https://github.com/DukeLearningInnovation/learn.duke/milestones) |


# Actors

Actor | Role
------|-----
Student | someone with read access to a community
Learning community manager | someone with edit access to a community. May or may not be the faculty teaching the course.
Learning Innovation | Functional owner of learn.duke
OIT | Technical owner of learn.duke
Duke Web Services | UX and design agency consulting on the creation of learn.duke

# Project Management
## Project Goals
1. Provide students a unified interface for accessing the apps used by their learning communities
1. Provide faculty a catalogue of learning technologies for use in their learning communities
1. Allow faculty to manage membership of and technologies used by their learning communities.
1. Provide information on learning technology management and policies.

## Stretch Goals
### Stretch Goals

1. Organize Kits to work with learning experiences from pre-matriculation to alumni learning
1. Let students know what they should do next for those classes.
1. Suggest apps packages, or standard sets of app combinations, to help faculty accomplish their learning objectives.
1. Solicit suggestions for new apps Duke should support, then Duke can research support, automation and provisioning behind the new apps.

## Projects
Github Projects are used to track sprints.
## Built With

* [Ruby on Rails](https://rubyonrails.org/) - Backend Framework
* [React](https://reactjs.org/) - Frontend Framework
* [Grouper](https://spaces.at.internet2.edu/display/Grouper/Grouper+Wiki+Home) - Group Management
* [Shibboleth](https://wiki.shibboleth.net/confluence/display/NEWS/) - Single Sign On
* [Learning Tools Interoperability (LTI)](https://www.imsglobal.org/activity/learning-tools-interoperability) - Integration Standard

## Terms

Term | Our definition | | |
-----|---------------|---|---
kit | Functionally, for the time being, a course. Technically, a context that ties a Grouper group for a roster + guests to apps used by that group. May also be referenced as a learning community
App | A technology used by a kit in the context of learning that is listed in /apps. Not limited to enterprise licensed technologies. School, departmental, and unlicensed apps will also be listed.
Ecosystem | All of the integrated technologies used for learning. Shortened synonym for Learning Technology Ecosystem. | |
User story| "As a *who*, I want *goal* so that *reasons*". These are the specification for design and development work. Acceptance criteria written in Gerkin These are tracked via a Github Label. | [All User Stories](https://github.com/DukeLearningInnovation/kits/issues?q=is%3Aopen+is%3Aissue+label%3A%22user+story%22) | [![Add User Story](https://img.shields.io/badge/Add-User%20Story-green.svg)](https://github.com/DukeLearningInnovation/kits/issues/new?template=user_story.md&labels=user%20story)
Assumption | Unknowns that require further discussion, user research, or development iterations to be known. These are tracked via a Github Label. | [All Assumptions](https://github.com/DukeLearningInnovation/kits/issues?q=is%3Aopen+is%3Aissue+label%3Aassumption) | [![Add User Story](https://img.shields.io/badge/Add-Assumption-green.svg)](https://github.com/DukeLearningInnovation/kits/issues/new?labels=assumption)
Hypothesis | A question used to drive design and development deliverables that can be tested in order to learn. Help explicitly state assumptions related to user stores. These are tracked via a Github Label. | [All Hypothesis](https://github.com/DukeLearningInnovation/kits/issues?q=is%3Aopen+is%3Aissue+label%3Ahypothesis) | [![Add Hypothesis](https://img.shields.io/badge/Add-Assumption-green.svg)](https://github.com/DukeLearningInnovation/kits/issues/new?labels=hypothesis)
MVP | The minimum viable piece/thing/product/idea/design we can build to validate or invalidate a hypothesis. These are tracked via Github Milestones. | [All MVP](https://github.com/DukeLearningInnovation/kits/milestones) |
Project | Github Projects are used to track sprints | [Current projects](https://github.com/DukeLearningInnovation/kits/projects) |

## Contributing

# Contributing
We don't have all the answers. We can't build it all by ourselves. Whether you're in or outside of Duke, read [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how you can contribute to this project.

0 comments on commit f3c96d4

Please sign in to comment.
You can’t perform that action at this time.