DocumentationGuidelines

From Eclipsepedia

Jump to: navigation, search
Warning2.png
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. s

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


In addition, portions of the existing Eclipse_Doc_Style_Guide guidelines have been used and extended.

Goals

This guideline is here to help the author of Eclipse Documentation use the wiki as their content source. To make sure that there is a consistent look and feel, this guideline will provide guidance on:

  • Authoring Resources
  • Style
  • Publishing

Those wishing to help contribute, are encouraged to do so.

Chapters

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.


References

These resources may be of additional use in helping to craft your projects user documentation.