Jump to: navigation, search

Difference between revisions of "DocumentationGuidelines"

Line 19: Line 19:
* Authoring Resources
* [[DocumentationGuidelines/AuthoringResources | Authoring Resources]]
* [[DocumentationGuidelines/Structure | Document Structure]]
* [[DocumentationGuidelines/Structure | Document Structure]]
* [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]]
* [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]]

Revision as of 15:58, 16 August 2009

Draft Content
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.

The Documentation Guidelines maintain a reference to important information when using the Eclipse Wiki for single sourcing eclipse project documentation. The eclipse documentation guidelines are heavily influenced by two very successful open source documentation projects:

This guide will may make reference and where appropriate cite the various sections from these guides.

If referencing another source, or summarizing information, provide a link or reference back to the original source.


The goals


The DocumentationGuidelines are made of of several pages and sub-pages. This section as well as the Category:Documentation and Category:Draft_Documentation pages can be used to review the relevant chapters.