Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.96 KB

DOC_WRITING_GUIDELINES.md

File metadata and controls

40 lines (28 loc) · 1.96 KB
Raw

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.
  • Check the meaning of words in Microsoft's A-Z word list and term collections (use the search input!).
  • RFC keywords should be used in technical documents (uppercase) and we recommend to use them in user documentation (lowercase). The RFC keywords are: "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". They are to be interpreted as described in RFC 2119.

Links

NOTE: Strongly consider the existing links - both within this directory and to the website docs - when moving or deleting files.

Relative links should be used nearly everywhere, due to versioning. Note that in case of page reshuffling, you must update all links references. When deleting a link, redirects must be created in docusaurus.config.js to preserve the user flow.

Code Snippets

Code snippets can be included in the documentation using normal Markdown code blocks. For example:

    ```go
    func() {}
    ```

It is also possible to include code snippets from GitHub files by referencing the files directly (and the line numbers if needed). For example:

    ```go reference
    https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/server/types/app.go#L57-L59
    ```

Technical Writing Course

Google provides a free course for technical writing.