Difference between revisions of "DocumentationGuidelines"

From Eclipsepedia

Jump to: navigation, search
m (Chapters)
 
Line 31: Line 31:
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/InternationalAudience Writing for an International Audience]
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/InternationalAudience Writing for an International Audience]
 
* [http://owl.english.purdue.edu/owl/resource/589/01/ Plagiarism.  How to Avoid it.]
 
* [http://owl.english.purdue.edu/owl/resource/589/01/ Plagiarism.  How to Avoid it.]
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/SpellingPunctuationGrammar Grammar, Puncuation, and Spelling...OH MY!]
+
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/SpellingPunctuationGrammar Grammar, Punctuation, and Spelling...OH MY!]
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/CommonlyConfusedWords No Excuse Errors.]
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/CommonlyConfusedWords No Excuse Errors.]
 
* [[DocumentationGuidelines/WikiSingleSourcing | Wiki Single Sourcing]]
 
* [[DocumentationGuidelines/WikiSingleSourcing | Wiki Single Sourcing]]

Latest revision as of 09:17, 4 November 2010

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, use either hyperlinks or use the Cite mediawiki extension to document the references.


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

[edit] 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
  • Grammar and Writing Style
  • Style
  • Publishing

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

[edit] 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.

[edit] References

These resources may be of additional use in helping to craft your project's user documentation.