2009-07-12 17:47:11 +00:00
|
|
|
.. _documentation-guidelines:
|
|
|
|
|
|
|
|
|
|
.. warning:: This document is for internal use only.
|
|
|
|
|
|
|
|
|
|
========================
|
|
|
|
|
Documentation Guildlines
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
Headline scheme
|
|
|
|
|
===============
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
===================================
|
|
|
|
|
First level (equals top and bottom)
|
|
|
|
|
===================================
|
2011-02-21 17:04:31 +00:00
|
|
|
|
2009-07-12 17:47:11 +00:00
|
|
|
Second Level (equals bottom)
|
|
|
|
|
============================
|
2011-02-21 17:04:31 +00:00
|
|
|
|
2009-07-12 17:47:11 +00:00
|
|
|
Third level (dashes botton)
|
|
|
|
|
---------------------------
|
2011-02-21 17:04:31 +00:00
|
|
|
|
2009-07-12 17:47:11 +00:00
|
|
|
Fourth level (drunken dashes bottom)
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Please try to use not more than 4 levels of headlines.
|
|
|
|
|
|
|
|
|
|
Overall salutation guidelines
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Use the *We* and *you*::
|
|
|
|
|
|
|
|
|
|
We think that you should send us a bottle of your local beer.
|
2011-02-21 17:04:31 +00:00
|
|
|
|
2009-07-12 17:47:11 +00:00
|
|
|
Some thoughts
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
* Many internal links are good
|
|
|
|
|
* Text should not be wider than 80 characters
|
2011-02-21 17:04:31 +00:00
|
|
|
* Two pages are better than one ultra-long page
|
