Warning: This article was written in 2020, the content might be out of date.
Warning: This article was written in 2020, the content might be out of date.
Categories: learning
A good software comes with a good documentation.
I finished reading the Technical Writing course to improve my technical writing. I did not know using active voice
, starts verb
in each bullet point, and using terms
consistently are so important in technical writing.
I revised few of my old documentation by following the Style Guide. It made a lot of improvement.
It is diffcult for a small team to start a style guide. If you are looking for one, Google and Microsoft style guide are a good starting point.