Versions Compared

Key

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

...

  1. Establish documentation timetables as offsets to Release Dates, for each deliverable or assignment
    1. Begin user documentation
      1. Sketch outlines: develop in tandem once specs 50% complete
      2. Sketch content: Spec completion/signoff + 1 week
      3. Drafting content: in tandem with code/development and iterative code reviews; should be able to complete outline and some content
    2. Draft #1 user Documentation: within 2 weeks of sprint release for coded feature
    3. Draft #2 user documentation: Within 2 weeks after release of final code for features, or Release overall
    4. Format Review copies due: Draft #2 date + 2weeks (time consuming)
    5. Initial QA Review due: Format Review Date + 1 week
    6. Final due: Initial QA date + 2 weeks
    7. Publish due: Final date + 1-2 weeks
  2. Add 10% +  contingency to Draft #2/Format Review dates (ie, some code won't be completed until just before release)
  3. Create Documentation calendar for each Release, with above offsets for global release
    1. Publish within 2-10 weeks of Release date (TBD with PM, depending on type of release, complexity, available resources)
  4. Coordinate schedule with Sprint Releases, and most current Milestone or Product Release schedules
    1. what are expectations for support, technical or user documentation:
      1. Snapshots: code only iterative/timely releases (biweekly sprints or future iterations, like 1.1, 1.1.1 etc)
      2. Milestone Releases: like OLE 0.3, 0.6, 0.8?
      3. Product Releases: like OLE 1.0, OLE 1.5, OLE 2.0 etc
  5. Monitor final code-promotion timetable to DEMO environment to determine when code for release is locked, and also when environments might be down
  6. Publish and communicate when servers are offline (maintenance, upgrades, refreshes, code promotions) and share with Writers- as they cannot access during those times for Screen Captures, etc.
    1. Suggestion: While we may wish to maintain separate KIS groups/lists/emails for SME Teams, vs Testers Team, vs User Documentation Team, why not build a distribution-only list for system outages or whenever DEV, TST, or DEMO go up/down? Could include SME team analysts, FC leads, TC leads, writers/User doc leads etc-- to convey system messages?

IV. Resources

  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)

...