Versions Compared

Key

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

...

  1. Garner support and SMEs via Tiger/SME Teams or thru Functional Council as additional resources for initial efforts
  2. Identify documentation lead per module
  3. Identify documentation team per module- existing, past, or current features (ideally a rep from each spec team, or testers)
  4. Like "testers", add documentation rep as assignment to each spec handoff, and begin integrating into code review meetings with SME teams
  5. Regular meetings and training
    1. Allow each module to have own meetings, organization, manage assignment
    2. Monthly meetings at beginning of release for "touch base" with all writers/all modules
    3. Bi-weekly documentation meetings (across all modules, and leads) in 1 month before release, and 2 months after release up to publishing date
  6. Create sandbox for shared documents (schedules, training material, templates, and sandboxes for each module's user documentation drafts)
  7. Training (how to, templates, best practices, checklists)
  8.  

V. Training

  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. Use of Sandbox, doc versioning, Track Changes
  8. 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

...