Page Comparison

...

Steps for OLE User Guides

Due date:

Nora has created a list of documentation needs in Google Docs: 2.0 Documentation List

...

1. Download a copy of the template, follow the directions in red to help fill out the content; work with other SMEs to complete
   1. KFS User Documentation Standards has helpful information about writing technical documentation.
2. Upload your document to Documentation 2.1 or Documentation 3.0 Google Drive Folder
3. Copy the link and paste it into the spreadsheet's Link to document (in Google Docs) column
4. Peer review
Put an "x" in the spreadsheet's Done? column when it is complete. 
5. Peer review
6. Let Nora know when you're done

If there is only additional information needed, find the link to the document in the

...

jira.

1. Edit the document/work with other SMEs to complete - PLEASE MAKE CHANGES IN A DIFFERENT COLOR TEXT; use strike through text to indicate deletion.
   1. KFS User Documentation Standards has helpful information about writing technical documentation.
2. Peer review
3. Put an "x" in the spreadsheet's Done? column when the document is complete.

Templates

TemplateEDoc.docx - for standard OLE e-docs. E-docs are for record keeping (financial documents, editor, etc).

...

1. Create output in .png format.
2. Add images as separate files to the designated document file within the Documentation 1.6 or Documentation 2.0 Google Drive Folder.
3. To improve legibility of text on the image, capture the largest image possible given the size of the computer screen you are using. Oversized screen images can be resized as needed in Oxygen.
4. If you are calling out items on your screenshot, please use classic/standard blue.
5. For each screen capture of an e-doc, only capture the e-doc.
6. For your reference, this is the standard in which screenshots should be included in our documentation:
   • For e-docs:
     • 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 maintenance e-docs:
     • Include only a full-length screenshot of the e-doc in edit mode. Do not include separate images of individual tabs.
   • For admin e-docs:
     • Include only a full-length screenshot of the initial display of the e-doc.
   • For interfaces:
     • Include an initial view screen shot.
     • Include screenshots to note steps in the process as necessary.

...