DEV Community

Writing Documentation

John J Owens on November 20, 2019

Why Write Documentation I like writing documentation because I would learn something new and I would share it with developers as many as...
Collapse
 
awwsmm profile image
Andrew (he/him)

Documentation is one of those things that seems obvious until it comes time to actually do it, then everyone groans. My personal approach is to document as I code. Breaking it up into small chunks like this not only reduces the psychological burden, but it also means that you're documenting what you're doing as you're doing it, so it's fresher in your mind! A win-win!

Collapse
 
cescquintero profile image
Francisco Quintero πŸ‡¨πŸ‡΄

That's right. Documenting and the way we document are important.

Also worth noting that documentation isn't limited to text but graphics, charts, tables, flows, etc.

There are many ways to document and not die while doing it xD

I wrote a blog post for the company I work regarding the topic.