diff options
Diffstat (limited to 'doc/process')
| -rw-r--r-- | doc/process/documentation-guidelines.md | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md index 59ed0a445..e75bb3169 100644 --- a/doc/process/documentation-guidelines.md +++ b/doc/process/documentation-guidelines.md @@ -41,7 +41,7 @@ This procedure works on Linux servers running Python 2.6 and higher. ### Use headings -Headings in markdown provide anchors that can be used to easily reference sub-sections of long pieces of documentation. This is preferrable to just numbering sections without headings. +Headings in markdown provide anchors that can be used to easily reference sub-sections of long pieces of documentation. This is preferable to just numbering sections without headings. ##### Correct: @@ -77,7 +77,24 @@ H3, H4, H5 headings should be "Sentence case" and can be any length. These headers are smaller and used to summarize sections. H3 can be considered either a large or small heading. -These conventions are new, so there's flexibility around them, when you're not sure, consider the convention here as default. +These conventions are new, so there's flexibility around them, when you're not sure, consider the convention here as default. + +### Sub-section headings should end with a colon + +For readability and clear layout, end a sub-section heading with a colon + +##### Correct: + +---- +Service Based: +- [AWS Elastic Beanstalk Setup](https://github.com/mattermost/platform/blob/master/doc/install/Amazon-Elastic-Beanstalk.md) +---- +##### Incorrect: + +---- +Optional +- [Community Guide for Production Debian Setup](https://github.com/mattermost/platform/blob/master/doc/install/Production-Debian.md) +---- ### One instruction per line @@ -102,20 +119,20 @@ A support person should be able to say "Did you complete step 7?" instead of "Di ---- -### Lists end without periods +### End Lists Consistently -Sentences within bullet points or numbered lists should end in normal punctuation. The sentence or fragment at the end of a bullet point should not have a period. +Full sentences in lists should end with proper punctuation. If one point in a bulleted list or numbered list ends with a period, end all points in the list with a period. If all points in the list are fragments, use no end punctuation. ##### Correct ---- -- This is a sentence within a bullet point. This is the end of a bullet point without a period +- This is an example of a bullet point that ends with a period. ---- ##### Incorrect ---- -- This is an incorrect ending of a bullet point with a period. +- Example of an incorrect period at the end of a bullet point. ---- ### Avoid Passive Phrases |