Versions Compared

Key

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

...

  1. Don't leave to last minute!
  2. Solicit help from other SMEs & manage mini writing assignments where helpful!
  3. Document Templates
    1. Publish format templates to sandbox
    2. Publish plain text with outline headings to sandbox
    3. Writers: plain text, and import to templates?
  4. Documentation Checklist: Content (bugs, fixes, new code, new screenshots, etc)
  5. Documentation Checklist: QA (overall)
  6. Documentation Checklist (Nora): Publishing
  7. Common glossary for documentation usage:
    1. 3rd person/you vs generic user, etc.
    2. User vs Staff vs. Operator (libraries have indicated their vernacular for "user" means patrons of library/users of library public catalog
    3. Other, esp OLE -defined terms and use of Document Store/DocStore; OLE Instance; OLE Holding vs Source Holding
  8. Links and usage of common elements documentation- do not include in every user guide, but provide hyperlinks to common/shared Glossary, Rice terms, Edoc elements, common actions/buttons, etc.
  9. Use of Sandbox, doc versioning, Track Changes
  10. Gliffy Sandbox: open-source modeling tool (like Visio!) for sharing and creating workflows, dataflows, or org chart models. Checkc out theĀ OLE Gliffy Sandbox Instructions

...