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) |
(→Development of User's Guide and Development Guide) |
||
| (13 intermediate revisions by the same user not shown) | |||
| 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 === | ||
| Line 23: | Line 24: | ||
# Final version distributed to reviewers | # Final version distributed to reviewers | ||
# Approval | # Approval | ||
| − | # Create PDF and online helps | + | # Create PDF, HTML and online helps |
# Test online helps | # Test online helps | ||
| − | === Document tools === | + | === Document review tool download and references === |
| − | 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 ''' | + | This section contains references to the Adobe Reader PDF review and commenting tool that will be used in reviewing document drafts. |
| + | |||
| + | * [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://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 === | ||
| + | |||
| + | 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. | 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 [http://wiki.eclipse.org/COSMOS_Document_DITA_ref DITA references]. | ||
Latest revision as of 10:12, 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 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.
- 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
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.