Page Comparison

{note}
Page under construction! Documentation planning and training are still works in process.
{note}
{section}
{column:width=60%}

h3. Purpose
This space provides information and tools for development of end user documentation for OLE. Most end users work in various departments within the library system and are not IT specialists. OLE documentation for end users are intended for use as aids in training new users and, thereafter, for reference.  

See: 
* [User Documentation Plan|OLE:User Documentation Planning] for more information about each type of documentation OLE plans to provide.
* [Module Overviews|OLE:OLE Requirements Overview] for the high level requirements that will be featured within the documentation.
* [Infrastructure basics|OLE:OLE and Rice-KFS] to see/learn more about global functionality.  The child pages will be linked from the documentation as needed.
* [Documentation Sandbox|OLE:0.8 User Documentation Sandbox] for the works in progress of the 0.8 documentation.

{column}
{column}
{panel:title=Contents|borderStyle=dashed|borderColor=#97A0A9|titleBGColor=#F2F8FF|bgColor=#F8FCFF}
{toc:outline=false|maxLevel=4}
{panel}
{column}
{section}

h3. The Plan for User Documentation

OLE plans to have two types of User Documentation (There are [more in the works|OLE:User Documentation Planning] but this page focuses only on User Documentation)  One will be a Drivers Manual and the other will be what we are playfully calling "The Big Book of OLE"
# The Drivers Manual will incorporate overviews and processes of each module as well as stories and examples to explain to users how OLE functions.
# The Big Book of OLE will include all the details of every eDoc within OLE.  This will eventually lead into online help.  

For example: A user will learn from the Drivers Manual that they will need to create a requisition but will find the specifics of how to do so and the explanations to every field within the Big Book.

h3. Writers Responsibilities

Writers for OLE Documentation are responsible for:
* Obtaining content from functional specs, SMEs, and their own work in OLE's UI.  Test Scripts may provide useful also, Nora has added comments in the Big Book that include links to OLETS (the OLE Test Jira ticketing system)
* Writing clear and concise user documentation in the OLE templates provided, according to OLE team standards for content, usage, punctuation, etc.  Please take a few minutes to review the [KFS User Documentation Standards|https://wiki.kuali.org/display/KULKFS/User+Documentation+Standards] for the inherited standards.
* Working with SMEs while preparing the original draft and during review cycles in order to improve the quality of content and presentation.
* Storing all drafts as attachments to the [Documentation Sandbox|OLE:0.8 User Documentation Sandbox]
* Handing off drafted sections to ...

h3. Diagrams, workflows in the Drivers Manual and Big Book

There are diagrams included within the documentation. If these need to be updated or replaced, contact [Nora Roggeveen-Sams|mailto:nroggeve@indiana.edu] as she has inherited the originals.  As many are from MS Visio, you may need to work together to make the required changes.

h3. Screenshots in the Big Book

* Make notes with the comment function of MS Word of any screenshots that need to be included or replaced (many have already been included in the "Big Book")
* For your reference, this is the standard in which screenshots should be included in our documentation:
** For e-docs accessible from the Main Menu tab:
Under 'Document Layout', insert a single full-length screen shot showing the entire e-doc as it displays when the user first accesses it from the menu. For most e-docs, this means the screen will be shown in create mode rather than edit mode.If the initial display is a search screen, use separate screen shots to show the initial search screen, the results of a search, and the screen display after selecting one of the e-docs listed in the results.
Under the subheading for each tab, insert a screen shot of the tab.
Under 'Process Overview', if you are documenting e-doc-specific processes and if screen shots will aid in user comprehension, include shots of parts of the screen that change.
** For e-docs accessible from the Maintenance menu tab:
Include only a full-length screen shot of the e-doc in edit mode. Do not include separate images of individual tabs.
** For e-docs accessible from the Administration menu tab:
Include only a full-length screen shot of the initial display of the e-doc.

h3. Links
There are already some links within OLE's Documentation.  However as this is still a work in progress, if you are unsure of the precise location just leave a comment.  This way it can be revisited in the future.

h4h3. OLE Test Environment
Please use the {link-window:http://tst.ole.kuali.org/|scrollbars=true|menubar=true|location=true|statusbar=true|resizable=true|width=800|height=600|icon=false}OLE Test Drive{link-window}.  This environment has a code promotion every other Friday.  See the [release documentation|OLE:OLE Release Documentation - for Milestone 0.8] to view the schedule and development progress.

h5. User IDs
In OLE, different users can perform different activities. Consequently, you need to log in as (that is, impersonate) the appropriate user whenever you need to access a particular e-doc or perform a specific task (such as editing or approving) the e-doc.  Be sure that these users are tracked in each module under Getting Started.

(!) If you are not familiar with logging in and out or switching users within OLE, please review the appropriate section under [OLE:Navigating through OLE]

h5. Finding which IDs to use
As noted above, some are already documented within the Big Book works in progress.  Others will be noted in specifications and test scenarios.


Some information from this page has been modified from [KFS Information for Writers|https://wiki.kuali.org/display/KULKFS/Information+for+Writers]