doc_styleguide.md 823 Bytes
Newer Older
Karen's avatar
Karen committed
1
2
3
4
# Documentation styleguide

This styleguide recommends best practices to improve documentation and to keep it organized and easy to find. 

Karen's avatar
Karen committed
5
## Text
Karen's avatar
Karen committed
6
7
8

* Make sure that the documentation is added in the correct directory and that there's a link to it somewhere useful.

Karen's avatar
Karen committed
9
* Add only one H1 or title in each document, by adding '#' at the begining of it (when using markdown). For subtitles, use '##', '###' and so on.
Karen's avatar
Karen committed
10
11
12
13
14
15
16
17
18
19
20
21

* Do not duplicate information.

* Be brief and clear.


## When adding images to a document

* Create a directory to store the images with the specific name of the document where the images belong. It could be in the same directory where the .md document that you're working on is located.

* Images should have a specific, non-generic name that will differentiate them.

Karen's avatar
Karen committed
22
* Keep all file names in lower case.