forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: adding documentation writing guidelines (cosmos#9366)
* docs: adding documentation writing guidelines * update * Apply suggestions from code review Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> Co-authored-by: likhita-809 <78951027+likhita-809@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
- Loading branch information
1 parent
f0b7f62
commit 1de12aa
Showing
2 changed files
with
23 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# 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. |