Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
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:
- Online helps
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.