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"
(→Chapters) |
(→Chapters) |
||
Line 18: | Line 18: | ||
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. | ||
+ | |||
+ | * Authoring Resources | ||
* [[DocumentationGuidelines/Structure | Document Structure]] | * [[DocumentationGuidelines/Structure | Document Structure]] | ||
* [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]] | * [[DocumentationGuidelines/StyleGuidelines | Style Guidelines]] |
Revision as of 16:57, 16 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.
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.
- Authoring Resources
- Document Structure
- Style Guidelines
- Publishing