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 Style Guidelines) |
(→Document Style Guidelines) |
||
| Line 43: | Line 43: | ||
* [http://wiki.eclipse.org/Eclipse_Doc_Style_Guide| Eclipse Doc Style Guide] | * [http://wiki.eclipse.org/Eclipse_Doc_Style_Guide| Eclipse Doc Style Guide] | ||
| − | * [http://wiki.eclipse.org/How_to_add_things_to_the_Eclipse_doc | How to add things to the Eclipse doc] | + | * [http://wiki.eclipse.org/How_to_add_things_to_the_Eclipse_doc| How to add things to the Eclipse doc] |
* [http://wiki.eclipse.org/Eclipse_Doc_Checklist| Eclipse Doc checklist] | * [http://wiki.eclipse.org/Eclipse_Doc_Checklist| Eclipse Doc checklist] | ||
* [http://www.eclipse.org/tptp/home/documents/process/development/translation_rules_of_thumb.html|Guidelines for preparing your code and documentation for translation] | * [http://www.eclipse.org/tptp/home/documents/process/development/translation_rules_of_thumb.html|Guidelines for preparing your code and documentation for translation] | ||
| Line 50: | Line 50: | ||
* [http://wiki.eclipse.org/UI_Graphics_:_Design_:_Style_&_Design| UI Graphic Design and Style] | * [http://wiki.eclipse.org/UI_Graphics_:_Design_:_Style_&_Design| UI Graphic Design and Style] | ||
* [http://wiki.eclipse.org/User_Interface_Guidelines#UI_Graphics_.283.x_Updates.29| User Interface Guidelines] | * [http://wiki.eclipse.org/User_Interface_Guidelines#UI_Graphics_.283.x_Updates.29| User Interface Guidelines] | ||
| + | * [http://www.eclipse.org/legal/legalfaq.php|Eclipse Foundation Legal Frequently Asked Questions (FAQ] | ||
== Other resources == | == Other resources == | ||
Revision as of 16:24, 12 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.
Document Style Guidelines
Use the following reference to learn about the Eclipse standards in writing, graphics and translations.
- Eclipse Doc Style Guide
- How to add things to the Eclipse doc
- Eclipse Doc checklist
- for preparing your code and documentation for translation
- Eclipse User Interface Guidelines
- How to Internationalize your Eclipse Plug-In
- UI Graphic Design and Style
- User Interface Guidelines
- Foundation Legal Frequently Asked Questions (FAQ
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.