DEV Community

Cover image for How does your company value documentation?
Benjamin Lannon
Benjamin Lannon

Posted on

How does your company value documentation?

Although many of us benefit from the usage of documentation of both internal and external products, compared to other portions of the codebase including testing or the actual code, documentation can sometimes be lacking.

I want to ask the community how does your company value documentation? If it doesn't as much as you wish, how do you sell to a manager or your team that it would be beneficial to have a stronger focus on documentation?

Top comments (1)

Collapse
 
helena_wz profile image
Lena Timofeeva

The company I work with (it's a client, but I'm based there full-time) requires to document every small change. Apparently, it takes more time to document things than development itself, which is crazy, and also doesn't really add value, as it's stored mostly in separate word files and not searchable.
I think it's important to 1) find a good balance of what needs to be documented, and what doesn't require extra explanation (people can't read long documents anyway); 2) organize documentation in a structured searchable way (i.e. Wiki-pages with categories and tags)