Difference between revisions of "Documentation:EditingGuidelines"
(Start laying out some documentation editing guidelines. Please add what you beleive is necessary.) |
m (orth :-)) |
||
| Line 7: | Line 7: | ||
One exception to this rule is the Documentation:Modules/* space. Each of these pages should focus on a specific modules, with greater detail than what can be put in the basic documentation. | One exception to this rule is the Documentation:Modules/* space. Each of these pages should focus on a specific modules, with greater detail than what can be put in the basic documentation. | ||
| − | == | + | == Formatting == |
| − | Page | + | Page formatting needs to be kept consistent. Check existing pages to see what that means. |
== Links between different docs == | == Links between different docs == | ||
Revision as of 16:57, 1 March 2007
This pages lists rules that should apply to all pages in the Official Documentation (ie the Documentation:* namespace in this wiki). Feel free to discuss additions to this list on the discussion page.
Contents
Structure
The docs (Play HowTo, Streaming HowTo, Hacker's Guide, etc.) should start by defining base concepts and gradually cover more advanced topics. The user should be able to read it sequentially (like any other online documentation, but unlike most wikis).
One exception to this rule is the Documentation:Modules/* space. Each of these pages should focus on a specific modules, with greater detail than what can be put in the basic documentation.
Formatting
Page formatting needs to be kept consistent. Check existing pages to see what that means.
Links between different docs
These are of course allowed. Just keep in mind the "Structure" rule :)
Links to other wiki pages and websites
The documentation needs to be self contained. Definitions of important concepts should be in the documentation. This makes it possible to export it as a PDF and keep it understandable. Links to advanced topics, like what you have in the "SEE ALSO" section in Unix man-pages, would of course be OK.
