DEV Community

Discussion on: Does documenting feel productive?

Collapse
 
dastasoft profile image
dastasoft

It is definitely necessary, especially in companies where there is a medium-high rotation of personnel.

I have been in places where some workers felt untouchable because they possessed knowledge that no one else had, while at the same time complaining that they always had to go through them to make certain developments.

It's a matter of time but there's a big component of discipline and having the routine to do it. Even though we all know that when time is running out, the first thing that is removed from planning is documentation.

Perhaps it is a mistake to think that the one who does the development should document it, since not everyone has the same communication skills or the will to do it and it should be delegated to a specific profile within the team.

Collapse
 
ben profile image
Ben Halpern

I have been in places where some workers felt untouchable because they possessed knowledge that no one else had, while at the same time complaining that they always had to go through them to make certain developments.

This is exactly what documentation is for.

I think good documentation can be inherently really really hard. Communication is tough, keeping things in sync is easier said than done, and hierarchy/reading order is just not easy to figure out when it's evolving at any time.

Unlike a self-containing blog post or book, docs can be random-access and getting it right is a skill that is hard to come by.

Collapse
 
codenamejason profile image
Jaxcoder • Edited

I don’t like those devs that keep everything to them. I try to share everything I know with everybody I work with on my immediate team so I always have back up for the company.

And yes getting it right it’s very difficult and a talent in itself.