Jump to: navigation, search

Difference between revisions of "DocumentationGuidelines"

(Chapters)
m (Chapters)
 
(16 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.
  
=Goals=
+
== 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:
 
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
 
* Authoring Resources
 +
* Grammar and Writing Style
 
* Style
 
* Style
 
* Publishing
 
* Publishing
Line 22: Line 23:
 
Those wishing to help contribute, are encouraged to do so.
 
Those wishing to help contribute, are encouraged to do so.
  
=Chapters=
+
== Chapters ==
  
 
The [[DocumentationGuidelines | 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.
 
The [[DocumentationGuidelines | 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.
 
  
 
* [[DocumentationGuidelines/AuthoringResources | Authoring Resources]]
 
* [[DocumentationGuidelines/AuthoringResources | Authoring Resources]]
 
* [[DocumentationGuidelines/ConvertExistingContent | Options for Converting Existing Content to MediaWiki]]
 
* [[DocumentationGuidelines/ConvertExistingContent | Options for Converting Existing Content to MediaWiki]]
* [[DocumentationGuidelines/Structure | Document Structure]]
+
* [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.]
 +
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/SpellingPunctuationGrammar Grammar, Punctuation, and Spelling...OH MY!]
 +
* [https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/CommonlyConfusedWords No Excuse Errors.]
 
* [[DocumentationGuidelines/WikiSingleSourcing | Wiki Single Sourcing]]
 
* [[DocumentationGuidelines/WikiSingleSourcing | Wiki Single Sourcing]]
 
* [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]]
 
* [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]]
 
* [[DocumentationGuidelines/Publishing | Publishing]]
 
* [[DocumentationGuidelines/Publishing | Publishing]]
 +
 +
== References ==
 +
These resources may be of additional use in helping to craft your project's user documentation.
 +
 +
* [[Eclipse_Doc_Style_Guide | Eclipse Documentation Style Guide]] (note this is geared toward HTML documentation).
 +
* [http://oreilly.com/oreilly/author/stylesheet.html O'Reilly Default Stylesheet and Word List].
 +
* [http://owl.english.purdue.edu/ Purdue University Online Writing Lab (OWL)].
 +
* [http://docs.fedoraproject.org//documentation-guide/ Fedora Documentation Project].
 +
* [https://wiki.ubuntu.com/DocumentationTeam Ubuntu Documentation Team].
 +
* [http://l10n.kde.org/docs//styleguide/index.html KDE 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.

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.

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 project's user documentation.
http://wiki.eclipse.org/index.php?title=DocumentationGuidelines&diff=226175&oldid=169070
wiki.eclipse.org
crawl=CC-MAIN-2017-13
47459
application/http; msgtype=response
sha1:VMKS3B6OEE2MSN2UDIDWOA2SSWY37ZKY
<urn:uuid:6c5cef63-9118-4673-afd9-d922a2a8fd14>
2017-03-24T20:34:48Z
198.41.30.197
sha1:3CGNGK5NJZCUZUGBTGJBI7ZTMYPMECIC
<urn:uuid:05aa5471-f17b-4d80-bbad-02f9f6df48a6>
http://wiki.eclipse.org/index.php?title=DocumentationGuidelines&diff=226175&oldid=169070
length
response
<urn:uuid:38f02888-115f-4493-b3f3-c94866a34b1f>
robots: classic
hostname: ip-10-233-31-227.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2017-13
operator: CommonCrawl Admin
description: Wide crawl of the web for March 2017
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf