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"
(→Other resources) |
|||
| Line 22: | Line 22: | ||
* [[COSMOS_Document_Naming | Wiki COSMOS document naming convention and Category association]] | * [[COSMOS_Document_Naming | Wiki COSMOS document naming convention and Category association]] | ||
* [http://wiki.eclipse.org/Category:COSMOS_Documentation COSMOS Documentation Category listing] | * [http://wiki.eclipse.org/Category:COSMOS_Documentation COSMOS Documentation Category listing] | ||
| + | |||
| + | === Document outlines === | ||
| + | The following templates shows the current planned layout for the User's Guide and Development Guide. | ||
| + | |||
| + | * [[COSMOS_Document_UG_template | User's Guide outline]] | ||
| + | * [[COSMOS_Document_Dev_Guide_template | Development Guide outline]] | ||
== Other resources == | == Other resources == | ||
| Line 27: | Line 33: | ||
* [[http://wiki.eclipse.org/Eclipse_Doc_Style_Guide | Eclipse Document Style Guide]] gives the style conventions to be used in Eclipse documents and helps. | * [[http://wiki.eclipse.org/Eclipse_Doc_Style_Guide | Eclipse Document Style Guide]] gives the style conventions to be used in Eclipse documents and helps. | ||
* [[COSMOS_Document_DITA_ref | DITA References]] provides references about DITA and samples of how to write DITA content. | * [[COSMOS_Document_DITA_ref | DITA References]] provides references about DITA and samples of how to write DITA content. | ||
| − | |||
| − | |||
* [[COSMOS_Document_Wiki_tips |Wiki tips and examples]] is a quick reference to Wiki information. | * [[COSMOS_Document_Wiki_tips |Wiki tips and examples]] is a quick reference to Wiki information. | ||
Revision as of 10:31, 6 February 2008
Welcome to the COSMOS documentation planning Wiki page.
Contents
Purpose
The purpose of this page is to provide information to develop the COSMOS User's Guide and 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 User's Guide and Development Guide will be developed on the Wiki. When the document content is available, it will be edited and inputted into a DITA format by 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 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.