Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "DocumentationGuidelines"
Line 10: | Line 10: | ||
{{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, provide a link or reference back to the original source.}} | ||
− | In addition, | + | In addition, portions of the existing [[Eclipse_Doc_Style_Guide]] guidelines have been used and extended. |
=Goals= | =Goals= |
Revision as of 00:12, 17 August 2009
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
In addition, portions of the existing Eclipse_Doc_Style_Guide guidelines have been used and extended.
Goals
The goals
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.