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 Documentation Plan"
(→Document outlines) |
(→Document outlines) |
||
| Line 33: | Line 33: | ||
The following templates shows the current planned layout for the User's Guide and Development Guide. | The following templates shows the current planned layout for the User's Guide and Development Guide. | ||
| + | * [[COSMOS_Getting_Started| Getting Started]] | ||
* [[COSMOS_InstallGuide10| Installation Guide V1.0]] | * [[COSMOS_InstallGuide10| Installation Guide V1.0]] | ||
* [[COSMOS_Document_UG_template | User's Guide outline]] | * [[COSMOS_Document_UG_template | User's Guide outline]] | ||
Revision as of 14:52, 7 February 2008
Welcome to the COSMOS documentation planning Wiki page.
Contents
Purpose
The purpose of this page is to provide information to develop the following documents to support the COSMOS GA.
- Installation Guide
- User's Guide
- Development Guide to support the COSMOS GA.
Provided are references to COSMOS document planning, scheduling, document links and other resources to assist in development of the documents.
The development content for the documentation will be developed on the Wiki.
The User's Guide and Development Guide contents will be inputted into a DITA format using the Epic editor. DITA content requires the content to be developed as topic-based writing. See references below for more information on DITA. PDF files will be provided for future reviews and online helps created for final output.
COSMOS document planning references
Document links
- COSMOS Manual Guide
- Wiki COSMOS document naming convention and Category association
- COSMOS Documentation Category listing
- Document files test procedure
Document outlines
The following templates shows the current planned layout for the User's Guide and Development Guide.
Other resources
The following resources are to assist you in developing documentation.
- Eclipse Document Style Guide gives the style conventions to be used in Eclipse documents and helps.
- DITA References provides references about DITA and samples of how to write DITA content.
- Wiki tips and examples is a quick reference to Wiki information.