Versions Compared

Version Old Version 25 New Version 26
Changes made by

Nora Roggeveen-Sams

Nora Roggeveen-Sams

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

I. Overview

  1. OLE requires committed SME's SMEs to complete User Documentation for all modules and all features delivered in the application, leveraging those SMEs with knowledge of the specifications, iterative code-reviews, and user-testing.
  2. Training, checklists, and best practices will be shared across among all Module SME team representatives,  and and the to-be-formed User Documentation team.
  3. User Documentation should be developed in tandem with release, and completion should closely follow a scheduled milestone or product release (see timelines-with some variation for milestone releases, depending on FC/PM decisions for support, schedule)-- progressive completions in tandem with coded features.

Item

Purpose

Audience

Owner

SME Contact

Reviewers

Notes

Drivers Manual/
User Documentation

Reference manual for details of how to use features of OLE. Provide case studies also to show how to use OLE in specific situations. Provide notation for where users can customize (Think story format; descriptions of how to do library tasks and overviews of each module)

All users of the software:
Hands on users
Partners

Nora
Jain?

Will need one per module

Will need to determine Reviewers

Need to figure out SMEs and dates

Technical Documentation

Provide information about the technical processes of OLE.
This explains how a core feature is designed and built. This is of importance to core contributing developers and others who may want to extend a feature and how a core feature can be used by an application developers.*

Library IT
System Admins
Those localizing OLE

HTC

 

 

Do we have someone specific to lead this?

Release Documentation

Provide detailed information about the changes and/or enhancements of each release of OLE. (Think what has changed; how it has changed. This will be a basic technical overview for functional users and SHORT!)

All users of the software:
Hands on users
Partners

Nora?

 

 

 

Online Help and "Big Book of OLE"

First line of reference when users have a question as they're using software. Provide look-up within the OLE system and details of the functions available within OLE. This will be very detailed and contain explanations of each OLE screens.

All users of the software:
Hands on users
Partners

Jain?
Nora

 

 

Working to determine which online help product to use. Continuing on the Big Book

Start-up guide

Provide instructions for how to set up and configure OLE. (Import patrons, bib data; set up chart of accounts, etc.)

All users of the software:
Hands on users
Partners
Library IT
System Admin

Nora with...

 

 

Do we want to do something like this? Or handle this in one of the other pieces of documentation? Kathy started CoA, already in Google Docs

...