Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width40%
Panel
borderColor#97A0A9
bgColor#F8FCFF
titleBGColor#F2F8FF
borderStyledashed
titleContentsborderStyledashed
Table of Contents
maxLevel5
minLevel2
Column
 

 

 

...

Steps for OLE User Guides

Due date:

Nora has created a list of documentation needs in Google Docs: 1.6 Documentation List and 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.6 or Documentation 23.0 Google Drive FolderCopy the link and paste it into the spreadsheet's Link to document (in Google Docs) column
  3. Peer reviewPut an "x" in the spreadsheet's Done? column when it is complete.
  4.  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 reviewPut 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).

...