...
- Don't leave to last minute!
- Solicit help from other SMEs & manage mini writing assignments where helpful!
- Document Templates
- Publish format templates to sandbox
- Publish plain text with outline headings to sandbox
- Writers: plain text, and import to templates?
- Documentation Checklist: Content (bugs, fixes, new code, new screenshots, etc)
- Documentation Checklist: QA (overall)
- Documentation Checklist (Nora): Publishing
- Common glossary for documentation usage:
- 3rd person/you vs generic user, etc.
- User vs Staff vs. Operator (libraries have indicated their vernacular for "user" means patrons of library/users of library public catalog
- Other, esp OLE -defined terms and use of Document Store/DocStore; OLE Instance; OLE Holding vs Source Holding
- 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.
- Use of Sandbox, doc versioning, Track Changes
- 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
...