I recently re-read Joel Chippindale's fantastic post about telling stories through your commits and I noticed that it was actually part of a talk he gave at a LeadDev conference in 2016. This led me to LeadDev's YouTube channel, where I came across a fantastic 10-minute talk by Beth Aitman at Lead Dev Berlin 2019 about writing effective documentation. From the video description, "Beth Aitman is a technical writer at Google, where she works to improve developer experience for Site Reliability Engineers. She’s interested in the intersection between UX and writing, and is passionate about teaching developers to write good docs."
I highly recommend watching it if you're working on any kind of software project that will be used or worked on by others. If you can't spare 10 minutes to watch it (seriously, just watch it!), I've included a short summary below.
In Beth's words, there are 6 guidelines to follow on the road to writing good docs:
Questions? Comments? Write to me at email@example.com.