Versions Compared

Version Old Version 18 New Version 19
Changes made by

Kathleen Gerdink (Unlicensed)

Kathleen Gerdink (Unlicensed)

Saved on

Key

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

...

  1. OLE requires committed SME's to complete User Documentation for all modules and all features delivered in the application. User documentation should be initiated well-before release deadlines, and in tandem with spec-writing, coding, and , leveraging those SMEs with knowledge of the specifications, iterative code-reviews, and user-testing.
  2. Training, checklists, best practices will be shared across all Module SME team representatives,  and the to-be-formed User Documentation team.
  3. User Documentation should be completed within 6-12 weeks after 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

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

All users of the software:
Hands on users
Partners

Nora?

 

 

 

Online Help

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

All users of the software:
Hands on users
Partners

Nora with...

 

 

Nora will need someone to assist in this effort

Start-up guide (question)

Provide instructions for how to set up and configure OLE

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 does have CoA already started in Google Docs

...