How to write high-quality friendly documentation that people want to read.
For the last few years I have written a lot of documentation for projects like Babel or Flow, blog posts, and guides such as these:
I've tried to focus on the way that I write in order to make it more approachable and more useful to everyone. There are a number of things that I have learned over the years that I believe makes for high-quality and friendly documentation.
Note: Some of this only really applies when you are talking about things that require tons of documentation. Try to adapt this advice to fit what you are working on best.
Here they are as one massive list:
This is a living guide for myself and others as I learn more about writing documentation. I hope it is helpful to others in its current state. If you have any suggestions, feel free to open an issue or pull request on GitHub and let me know.
Have fun writing!