Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Information Plan"
(→Documents) |
(→Availablility) |
||
Line 10: | Line 10: | ||
=== Availablility === | === Availablility === | ||
* Documents available two weeks before GA in the following formats: | * Documents available two weeks before GA in the following formats: | ||
− | ** PDF | + | ** PDF for reviews |
** Online helps | ** Online helps | ||
+ | ** HTML output for Web | ||
=== Milestones === | === Milestones === |
Revision as of 09:24, 6 February 2008
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.
- Document outlines
- First draft
- Review
- Second draft
- Review
- Final version distributed to reviewers
- Approval
- Create PDF and online helps
- Test online helps
Document tools
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 DITA (Darwin Information Typing Architecture).
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.