DEV Community

Discussion on: How to write clear and concise documentation

Collapse
 
jankapunkt profile image
Jan Küster

Very focused and on point. Any good literature you can suggest on documentation and concepts like these?

Collapse
 
erikmelone profile image
Erik Melone • Edited

I have honestly struggled to find many good books on documentation from a Software Engineering perspective. There is a lot of literature and content out there around "Technical Writing" from a general perspective that you could look into. I personally have not read too much in this area since none of it seems applicable to my job as a Software Engineer.

That being said, here are two excellent books that look at writing documentation from more of a Software Engineers perspective:

I also plan to write a whole lot more on the topic, looking to publish a post weekly. So, you can also stay tuned for that!

Collapse
 
jankapunkt profile image
Jan Küster

Thanks for the two links I will definitely stay tuned as I currently see the benefits of documentation with onboarding my juniors

Collapse
 
naivekook profile image
Vladimir

Google has a course about technical writing, it is a good starting point
developers.google.com/tech-writing