DEV Community

Discussion on: Not Documented, Not Done

Collapse
 
quii profile image
Chris James

I've worked in places where every problem is met with "we should've documented this better" over and over again. So people document lots of stuff. Problem is it's not challenging the real issues, with the organisation and the code

Imagine you are put on a project already on course and you have 3 days to implement a feature without absolutely no context at all.

I'd quit. Documentation is not the long term solution to this kind of madness.

Another example. Team decided we needed to create lots of documentation for the release process, this is not at all uncommon even when you have CI tools. Documentation is not the solution here, a simple release process is.

I'm not against documentation, but its not the panacea it's often seen as.

Collapse
 
tiagodenoronha profile image
Tiago de Noronha

True, maybe the example was an overkill :)

Often I don't encounter those types of projects, but that doesn't mean they don't exist. But here is where I disagree, Documentation is the solution. You stop doing features and you consolidate the features that already exist by documenting them :)

Normally we set templates for types of CI and CD processes, which we (and normally I) document :b