DEV Community

Discussion on: Writing proper documentation. Why is it so hard?

Collapse
davidjames profile image
DavidJames

I write ERP software integrations (and such) for a fairly large utility and have been doing it for about 25 years. I write the documentation at the end of a 'project' and find it's an extremely useful way for me to review what I did and have it completely fresh in my mind when I hand [the app] over to it's ... requester. I go way over the top using Word and tables and all of that crap (that most developers hate to deal with) because at least once a year someone will need a doc I created and I'll get to her "Holy crap you write great docs!". That comment usually happens in a meeting with lots of people in it. Word gets around and my life is easier.