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) |
|||
| (23 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
=== Purpose === | === Purpose === | ||
| − | The purpose of this page is to provide information to develop the COSMOS User's Guide | + | 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. | 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 | + | 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 == | == COSMOS document planning references == | ||
| Line 20: | Line 26: | ||
== Document links == | == Document links == | ||
* [[COSMOS_Documentation_Topics | COSMOS Manual Guide]] | * [[COSMOS_Documentation_Topics | COSMOS Manual Guide]] | ||
| − | |||
* [http://wiki.eclipse.org/Category:COSMOS_Documentation COSMOS Documentation Category listing] | * [http://wiki.eclipse.org/Category:COSMOS_Documentation COSMOS Documentation Category listing] | ||
| Line 26: | Line 31: | ||
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_DEMO_i11| COSMOS Demo Installation i11]] | ||
* [[COSMOS_Document_UG_template | User's Guide outline]] | * [[COSMOS_Document_UG_template | User's Guide outline]] | ||
* [[COSMOS_Document_Dev_Guide_template | Development Guide outline]] | * [[COSMOS_Document_Dev_Guide_template | Development Guide outline]] | ||
| + | |||
| + | === Document Guidelines and References === | ||
| + | Use the following reference to learn about the Eclipse standards in writing, graphics and translations. | ||
| + | |||
| + | * [http://wiki.eclipse.org/Eclipse_Doc_Style_Guide Eclipse Doc Style Guide] | ||
| + | * [http://wiki.eclipse.org/COSMOS_Document_Graphic_Guidelines Graphic Guidelines for Documents] | ||
| + | * [[COSMOS_Document_Naming | Wiki COSMOS document naming convention and Category association]] | ||
| + | * [http://wiki.eclipse.org/How_to_add_things_to_the_Eclipse_doc How to add things to the Eclipse doc] | ||
| + | * [[COSMOS_Doc_File_Test_Procedure | Document files test procedure]] | ||
| + | * [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 in how to prepare your code and documentation for translation] | ||
| + | * [http://www.eclipse.org/articles/Article-Internationalization/how2I18n.html How to Internationalize your Eclipse Plug-In] | ||
| + | * User Interface links: | ||
| + | ** [http://www.eclipse.org/articles/Article-UI-Guidelines/Index.html Eclipse User Interface Guidelines] | ||
| + | ** [http://wiki.eclipse.org/UI_Graphics_:_Design_:_Style_&_Design%20UI%20Graphic%20Design%20and%20Style UI Graphics : Design : Style] | ||
| + | ** [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 == | ||
The following resources are to assist you in developing documentation. | The following resources are to assist you in developing documentation. | ||
| − | * | + | * [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. | ||
| + | |||
| + | * [http://www.alphaworks.ibm.com/tech/taskmodeler?open&S_TACT=105AGX59&S_CMP=GR&ca=dgr-jw26awtaskmodele IBM Task Modeler] is an Eclipse-based software tool for modeling human activity as a hierarchy of tasks and related elements. An information architect can use it to design DITA (Darwin Information Typing Architecture) maps. A usability practitioner can produce either classic HTA (Hierarchical Task Analysis) diagrams or RAG (Roles and Goals) diagrams. The tool can be used in a workshop, during a field study, or at one's desk to rapidly create, explore, analyse, and share these models." | ||
| + | |||
| + | |||
| + | [[Category:COSMOS_Documentation]] | ||
Latest revision as of 07:54, 18 June 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
Document outlines
The following templates shows the current planned layout for the User's Guide and Development Guide.
Document Guidelines and References
Use the following reference to learn about the Eclipse standards in writing, graphics and translations.
- Eclipse Doc Style Guide
- Graphic Guidelines for Documents
- Wiki COSMOS document naming convention and Category association
- How to add things to the Eclipse doc
- Document files test procedure
- Eclipse Doc checklist
- Guidelines in how to prepare your code and documentation for translation
- How to Internationalize your Eclipse Plug-In
- User Interface links:
- Eclipse 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.
- IBM Task Modeler is an Eclipse-based software tool for modeling human activity as a hierarchy of tasks and related elements. An information architect can use it to design DITA (Darwin Information Typing Architecture) maps. A usability practitioner can produce either classic HTA (Hierarchical Task Analysis) diagrams or RAG (Roles and Goals) diagrams. The tool can be used in a workshop, during a field study, or at one's desk to rapidly create, explore, analyse, and share these models."