Versions Compared

Key

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

...

*see outlines being developed for content of each module (attachments to this or other documentation pages)

III. Timeline

  1. Establish documentation timetables as offsets 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 10 weeks of Release date
  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
      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. Future Coding/Deliverables added
  2. Feature Enhancements
  3. Documentation Improvements (format, indexing, maximizing Adobe PDF outlining/indexing)
  4. Online Help
  5. Archiving between releases
Attachments