822 B
822 B
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!).
Technical Writing Course
Google provides a free course for technical writing.