...
Item | Purpose | Audience | Owner | SME Contact | Reviewers | Notes |
---|---|---|---|---|---|---|
Drivers Manual/ | 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: | Nora | 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 | Library IT | 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: | 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: | Jain? |
|
| 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: | Nora with... |
|
| Do we want to do something like this? Or handle this in one of the other pieces of documentation? Kathy does have started CoA, already started in Google Docs |
* Taken from https://wiki.kuali.org/display/KULRICE/Documentation+Policy
...