As a follow-up to my last video, I wanted to share some tips on writing good documentation, based on my own experience.
Summary of the tips:
✔️ Keep articles short
✔️ Cover one main concept per article
✔️ Use every name of the concept
✔️ If more than one person asks, write about it
✔️ Collaborate! Make it a team effort
✔️ Use plenty of examples
✔️ Use screenshots
✔️ Use simple diagrams
✔️ No read/write controls
✔️ Link to documentation from tasks, chat messages, etc.
Latest comments (1)
Thanks for the tips. I enjoyed them a lot. Hopefully they will make my docs clearer and more user friendly.