DEV Community

Discussion on: How to avoid comprehensive documentation/ over-documentation?

Collapse
 
agazaboklicka profile image
Aga Zaboklicka

Yes, everything is separate. Some projects require even more documents. I understand the value of good documentation, but it's more about the process here. I remember writing high-level design, software system design and then describing the actual changes.

It'll be hard without a design - the think before implementation is important, but if the design has to be rewritten every time we miss the point...?

I believe that we can write 2 and then extend it to the new document by adding extra changes eventually. (You know, deliver 2 and 2-based 3 or 3 and 3-based 4) I never read any documentation, but the code isn't self-documenting itself either. It'll require the contribution of every developer.
The documentation is always written quite early and then we need to rewrite it.