Thursday, May 31, 2018

Unified ReadTheDocs Documentation

Documentation! It's, unfortunately, the neglected "red-headed stepchild" of developers. Most people don't get it: a product is useless without solid documentation. Even to this day, most of our developers avoid documenting. "Dude, the code documents everything," they say. To change the mindset, we need to avoid barriers and make authoring content a pleasure.

Documentation Dilemma

I personally love documenting, even before I start working on a new idea or writing code. It helps to get your thoughts together. Authoring documents should be pleasant and effortless for all authors, whether you're an engineer writing technical specifications for fellow developers or writing product manual for end users.



from DZone.com Feed https://ift.tt/2smQv26

No comments:

Post a Comment