diff options
| -rw-r--r-- | doc_styleguide.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc_styleguide.md b/doc_styleguide.md new file mode 100644 index 00000000000..c1ad7a15206 --- /dev/null +++ b/doc_styleguide.md @@ -0,0 +1,29 @@ +# Documentation styleguide + +This styleguide recommends best practices to improve documentation and to keep it organized and easy to find. + +## Text (when using markdown) + +* Make sure that the documentation is added in the correct directory and that there's a link to it somewhere useful. + +* Add only one H1 or title, by adding '#' at the begining of it. + +* For subtitles, use '##', '###' and so on. + +* Do not duplicate information. + +* Be brief and clear. + +* To add images use +´´´ + +´´´ + + +## 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. + +* Keep all file names in lower case. |