github.com/Finschia/finschia-sdk@v0.48.1/docs/DOC_WRITING_GUIDELINES.md (about)

     1  # Documentation Writing Guidelines
     2  
     3  ## Best Practices
     4  
     5  + Check the spelling and grammar, even if you have to copy and paste from an external source.
     6  + Use simple sentences. Easy-to-read sentences mean the reader can quickly use the guidance you share.
     7  + Try to express your thoughts in a concise and clean way.
     8  + Don't abuse `code` format when writing in plain English.
     9  + Follow Google developer documentation [style guide](https://developers.google.com/style).
    10  + 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!).
    11  + 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](https://datatracker.ietf.org/doc/html/rfc2119).
    12  
    13  ## Technical Writing Course
    14  
    15  Google provides a free [course](https://developers.google.com/tech-writing/overview) for technical writing.