Difference between revisions of "Orion/Documentation"

From Eclipsepedia

Jump to: navigation, search
 
Line 1: Line 1:
 +
Documentation for Orion is divided into two major books:
 +
 +
; [[Orion/Documentation/User Guide| Orion User Guide]]
 +
: A guide for end users of an Orion-based application. This documentation avoids any technical jargon or implementation terms that do not already surface in the user interface.
 +
; [[Orion/Documentation/Developer Guide| Orion Developer Guide]]
 +
: A guide for people building Orion-based applications or extensions. This includes information on our APIs, and more detailed technical documentation on the concepts and design of Orion. This is sometimes also referred to as Independent Software Vendor (ISV) documentation.
 +
 +
== Documentation Guidelines ==
 
Orion documentation is authored primarily on this wiki. This documentation is then converted into standalone HTML documentation in the build using [[Mylyn/WikiText]]. All child pages of this page are included in Orion builds. This documentation is held to a higher standard than typical Eclipse wiki content. The following rules must be followed:
 
Orion documentation is authored primarily on this wiki. This documentation is then converted into standalone HTML documentation in the build using [[Mylyn/WikiText]]. All child pages of this page are included in Orion builds. This documentation is held to a higher standard than typical Eclipse wiki content. The following rules must be followed:
 
* Do NOT move or rename any of these pages without updating the corresponding build script.
 
* Do NOT move or rename any of these pages without updating the corresponding build script.
Line 5: Line 13:
 
* Only include documentation for fully implemented features. Do not include design plans for future feature work, or other transient developer documentation.
 
* Only include documentation for fully implemented features. Do not include design plans for future feature work, or other transient developer documentation.
 
* Do not use wiki Category tags on these pages, as they do not convert nicely to HTML
 
* Do not use wiki Category tags on these pages, as they do not convert nicely to HTML
 
Documentation for Orion is divided into two major books:
 
 
; [[Orion/Documentation/User Guide| Orion User Guide]]
 
: A guide for end users of an Orion-based application. This documentation avoids any technical jargon or implementation terms that do not already surface in the user interface.
 
; [[Orion/Documentation/Developer Guide| Orion Developer Guide]]
 
: A guide for people building Orion-based applications or extensions. This includes information on our APIs, and more detailed technical documentation on the concepts and design of Orion. This is sometimes also referred to as Independent Software Vendor (ISV) documentation.
 
  
 
All other documentation, such as information for committers and contributors to the Orion project, should remain elsewhere on the [[Orion]] wiki.
 
All other documentation, such as information for committers and contributors to the Orion project, should remain elsewhere on the [[Orion]] wiki.
 
== TODO ==
 
 
* How to reference jsdoc from the documentation
 
* References within jsdoc use @link
 
* Recommended Usage of JSDoc
 
  
 
[[Category:Orion|Documentation]]
 
[[Category:Orion|Documentation]]

Latest revision as of 14:38, 17 October 2012

Documentation for Orion is divided into two major books:

Orion User Guide
A guide for end users of an Orion-based application. This documentation avoids any technical jargon or implementation terms that do not already surface in the user interface.
Orion Developer Guide
A guide for people building Orion-based applications or extensions. This includes information on our APIs, and more detailed technical documentation on the concepts and design of Orion. This is sometimes also referred to as Independent Software Vendor (ISV) documentation.

[edit] Documentation Guidelines

Orion documentation is authored primarily on this wiki. This documentation is then converted into standalone HTML documentation in the build using Mylyn/WikiText. All child pages of this page are included in Orion builds. This documentation is held to a higher standard than typical Eclipse wiki content. The following rules must be followed:

  • Do NOT move or rename any of these pages without updating the corresponding build script.
  • Follow the style guidelines in the Eclipse Doc Style Guide.
  • Documentation must remain up to date with current features in origin/master in our Git repository.
  • Only include documentation for fully implemented features. Do not include design plans for future feature work, or other transient developer documentation.
  • Do not use wiki Category tags on these pages, as they do not convert nicely to HTML

All other documentation, such as information for committers and contributors to the Orion project, should remain elsewhere on the Orion wiki.