How do I write good documentation?

Question

I got a freelance job recently, that wants me to write documentation for a static site hosting platform, the thing is, I've never written or even edited a documentation before. how should I go about it? any tips?

taubek · Accepted Answer

If you have time go through Google course for technical writers. [1] Also Write the Docs has a great Guide [2][1] https://developers.google.com/tech-writing[2] https://www.writethedocs.org/guide/

warrenm · Answer

First, practiceSecond, read other's examples (eg MSDN, developerWorks, Docs.Splunk)Third, practiceFourth, get feedback (and incorporate all the constructive bits)Fifth, practiceSixth, focus on why more than how; leave out used to be in favor of this is now; be concise; crosslink other docsSeventh, make it maintainable - you do not want to "own" this forever and always...eventually you won't be there: make it something someone else can pick up and run with (and not have to recreate from scratch)----------Some resources I've written (and a Wikipedia page):- https://writing.stackexchange.com/a/33505/1317- https://writing.stackexchange.com/a/33578/1317- https://pm.stackexchange.com/q/799/167- https://en.wikipedia.org/wiki/DIKW_pyramid- https://antipaucity.com/2013/10/11/theres-never-enough-docum...- https://antipaucity.com/2013/02/10/organizational-knowledge-...

ss48 · Answer

https://diataxis.fr/ gives some good guideline for classifying types of documentation .

hoot · Answer

Get ChatCPT to write it.