#76: Documentation

Contents

1. Motivation
2. Proposal
3. Deliverables
4. Participants

Proposed by

Tom Caswell

Proposal type

User interface

Assigned to release

• eduCommons 3.2.0 (Unreleased)

State

in-progress

Motivation

One of the goals of eduCommons is to be easy enough to use that content producers can focus on creating high quality content, rather than having to worry about learning HTML or a complex CMS. Good documentation, including screencasts, can help new content producers and other non-technical contributors quickly familiarize themselves with the eduCommons interface.

Proposal

Documentation should be expanded to help content producers, translators, and other users learn to use eduCommons. Screencasts demonstrating the essential functions of working in eduCommons should also be created.

Deliverables

1. Updated eduCommons 3.2.0 tutorials. The tutorials should include the 9 sections created for eduCommons 3.0.0. These should be revised and converted to reStructured Text so they can be used in a variety of formats including HTML, PDF, and plain text. The individual tutorial sections may end up being used within the contextual help system (see http://cosl.usu.edu/projects/educommons/roadmap/67).
2. Bundled documentation: INSTALL.txt, MIGRATION.txt, and IMSContentPackaging.txt to be updated by enPraxis. SETUP.txt and LOCALIZATION.txt to be updated by Seth.
3. Screencasts. This should include all the same sections from the eduCommons 3.0.0 screencasts (http://cosl.usu.edu/projects/educommons/documentation/screencasts/), plus additional sections highlighting the new functionality of eduCommons 3.2.0.

Participants

Seth Guerell, enPraxis