Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
DocumentationGuidelines
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
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.
- Authoring Resources
- Options for Converting Existing Content to MediaWiki
- Writing for an International Audience
- Plagiarism. How to Avoid it.
- Grammar, Punctuation, and Spelling...OH MY!
- No Excuse Errors.
- Wiki Single Sourcing
- Style Guidelines
- Publishing
References
These resources may be of additional use in helping to craft your project's user documentation.
- Eclipse Documentation Style Guide (note this is geared toward HTML documentation).
- O'Reilly Default Stylesheet and Word List.
- Purdue University Online Writing Lab (OWL).
- Fedora Documentation Project.
- Ubuntu Documentation Team.
- KDE Style Guide.
- GNOME Style Guide.
- Wikipedia Article on Style Guides.