Jump to: navigation, search

COSMOS Document Information Plan

COSMOS Wiki > COSMOS Document Plan


Documents

There will be two documents:

  • COSMOS Installation Guide
  • COSMOS User's Guide
  • COSMOS Developer's Guide

Availablility

  • Documents available two weeks before GA in the following formats:
    • PDF for reviews
    • Online helps
    • HTML output for Web

Milestones

The development of a document consists the following chronological milestones.

  1. Document outlines
  2. First draft
  3. Review
  4. Second draft
  5. Review
  6. Final version distributed to reviewers
  7. Approval
  8. Create PDF, HTML and online helps
  9. Test online helps

Document review tool download and references

This section contains references to the Adobe Reader PDF review and commenting tool that will be used in reviewing document drafts.

Development of User's Guide and Development Guide

This section contains information about the tools being used to develop the User's Guide and Development Guide. These tools will be used by the writer to the PDF's, HTML output and online helps.

The two document will be created using a tool called Information Development Workbench (IDWB). IDWB is a structured XML/SGML authoring and editing application for writers of technical documentation. The Epic editor will be used to construct the documents using Darwin Information Typing Architecture (DITA).

DITA is an XML-based, end-to-end architecture for authoring, producing, and delivering technical information. This architecture consists of a set of design principles for creating "information-typed" modules at a topic level and for using that content in delivery modes such as online help and product support portals on the Web.

For more information on DITA, see DITA references.