Difference between revisions of "DocumentationGuidelines"

From Eclipsepedia

Jump to: navigation, search
(References)
m (Chapters)
 
(5 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
This guide will may make reference and where appropriate cite the various sections from these guides.   
 
This guide will may make reference and where appropriate cite the various sections from these guides.   
 
s  
 
s  
{{important |Citations|If referencing another source, or summarizing information, provide a link or reference back to the original source.}}
+
{{important |Citations|If referencing another source, or summarizing information, use either hyperlinks or use the [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite mediawiki extension] to document the references.}}
  
 
In addition, portions of the existing [[Eclipse_Doc_Style_Guide]] guidelines have been used and extended.
 
In addition, portions of the existing [[Eclipse_Doc_Style_Guide]] guidelines have been used and extended.
Line 17: Line 17:
  
 
* Authoring Resources
 
* Authoring Resources
 +
* Grammar and Writing Style
 
* Style
 
* Style
 
* Publishing
 
* Publishing
Line 29: Line 30:
 
* [[DocumentationGuidelines/ConvertExistingContent | Options for Converting Existing Content to MediaWiki]]
 
* [[DocumentationGuidelines/ConvertExistingContent | Options for Converting Existing Content to MediaWiki]]
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/InternationalAudience Writing for an International Audience]
 
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/InternationalAudience Writing for an International Audience]
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/SpellingPunctuationGrammar Grammar, Puncuation, and Spelling...OH MY!]
+
* [http://owl.english.purdue.edu/owl/resource/589/01/ Plagiarism.  How to Avoid it.]
 +
* [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]]
Line 45: Line 47:
 
* [http://l10n.kde.org/docs//styleguide/index.html KDE Style Guide].
 
* [http://l10n.kde.org/docs//styleguide/index.html KDE Style Guide].
 
* [http://library.gnome.org/devel/gdp-style-guide/stable/ GNOME Style Guide].
 
* [http://library.gnome.org/devel/gdp-style-guide/stable/ GNOME Style Guide].
 +
* [http://en.wikipedia.org/wiki/Style_guide Wikipedia Article on Style Guides].
  
 
[[Category:Documentation_Guidelines ]]
 
[[Category:Documentation_Guidelines ]]
 
[[Category:Draft_Documentation ]]
 
[[Category:Draft_Documentation ]]

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.
http://wiki.eclipse.org/index.php?title=DocumentationGuidelines&diff=226175&oldid=169284
wiki.eclipse.org
crawl=CC-MAIN-2014-35
34292
application/http; msgtype=response
sha1:C3B3ZLYP3ZZGNQT2UBBZOIHX25U7LO5F
<urn:uuid:c3e9d1cc-2a8a-485d-9f4f-de5019e68a2c>
2014-08-21T00:04:47Z
198.41.30.197
sha1:AWVUXDJODIG6W4MTHQW7L6TYWKXOPW3C
<urn:uuid:02ffef3e-57b4-4c09-99e9-a6190b994c28>
http://wiki.eclipse.org/index.php?title=DocumentationGuidelines&diff=226175&oldid=169284
response
<urn:uuid:bba7da2d-4465-4320-a7a0-583ddc6e8d28>
robots: classic
hostname: ip-10-180-136-8.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2014-35
operator: CommonCrawl Admin
description: Wide crawl of the web with URLs provided by Blekko for August 2014
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf