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.
Difference between revisions of "COSMOS Document Information Plan"
(→Document tools) |
|||
| Line 27: | Line 27: | ||
# Test online helps | # Test online helps | ||
| − | + | == Document tools == | |
| + | This section contains references to the PDF review and commenting tool and the DITA tool the writer will be using to create the PDF, HTML and online helps output. | ||
| + | |||
| + | === PDF Review Tool === | ||
* [http://www.adobe.com/products/reader/ Adobe Reader download] Web site | * [http://www.adobe.com/products/reader/ Adobe Reader download] Web site | ||
* [http://www.adobe.com/products/reader/pdfs/reader_user_guide.pdf Adobe Reader User's Guide] (PDF, 6.92MB) | * [http://www.adobe.com/products/reader/pdfs/reader_user_guide.pdf Adobe Reader User's Guide] (PDF, 6.92MB) | ||
* [http://help.adobe.com/en_US/Reader/8.0/help.html?content=WSA13C481B-B0A1-41d5-ADDF-3C669541CA35.html Adobe Help Resource] Web site provides information on how to use the commenting and markup tools to review PDFs. | * [http://help.adobe.com/en_US/Reader/8.0/help.html?content=WSA13C481B-B0A1-41d5-ADDF-3C669541CA35.html Adobe Help Resource] Web site provides information on how to use the commenting and markup tools to review PDFs. | ||
| − | + | === Development of User's Guide and Development Guide === | |
| − | + | ||
| − | + | ||
| − | + | ||
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)'''. | 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. | 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. | ||
Revision as of 09:59, 6 February 2008
COSMOS Wiki > COSMOS Document Plan
Contents
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, HTML and online helps
- Test online helps
Document tools
This section contains references to the PDF review and commenting tool and the DITA tool the writer will be using to create the PDF, HTML and online helps output.
PDF Review Tool
- Adobe Reader download Web site
- Adobe Reader User's Guide (PDF, 6.92MB)
- Adobe Help Resource Web site provides information on how to use the commenting and markup tools to review PDFs.
Development of User's Guide and Development Guide
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.