98cf72c4ba
* fix: misc fixes for make to work off freshly cloned repo * gocritic appendAssign fix * markdown trailing space and blank line fixes * change golangci-lint timeout to 5min * update changelog * Update .golangci.yml Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> * Update CHANGELOG.md Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
15 lines
820 B
Markdown
15 lines
820 B
Markdown
# Documentation Writing Guidelines
|
|
|
|
## Best Practices
|
|
|
|
+ Check the spelling and grammar, even if you have to copy and paste from an external source.
|
|
+ Use simple sentences. Easy-to-read sentences mean the reader can quickly use the guidance you share.
|
|
+ Try to express your thoughts in a concise and clean way.
|
|
+ Don't abuse `code` format when writing in plain English.
|
|
+ Follow Google developer documentation [style guide](https://developers.google.com/style).
|
|
+ Check the meaning of words in Microsoft's [A-Z word list and term collections](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms) (use the search input!).
|
|
|
|
## Technical Writing Course
|
|
|
|
Google provides a free [course](https://developers.google.com/tech-writing/overview) for technical writing.
|