DEV Community

Discussion on: Documentation is my gateway to coding

moopet profile image
Ben Sinclair

I love writing documentation, not just from an API point of view. I'm given a lot of leeway as to how I implement the back-end UI for things and I try to keep screenshots and tutorials up to date for CMS administrators and so forth.

A couple of jobs ago I worked with someone who was, like, a professional technical writer, and that experience has made me push for my bosses to employ TWs everywhere I've worked. Haven't made much headway, but I keep trying.

lepinekong profile image

Most developers hate writing documentation as far as I can see on projects I've managed in big corps mostly because it's a daunting process and it takes too much time to maintain (I mean true doc not just useless comments) so I'm working on a format and above all tooling to ease this for all programming languages - there are already javadoc for java for example but it will be a layer above.
It's far from being there because I have a lot of other stuffs, at the moment there is a core format here - that I have to better document I know :)