DEV Community

Discussion on: Don't Drown in Documentation

Collapse
 
mdabek profile image
Marek Dabek • Edited

The software industry is immersed in other industries. The product is not always a complete, end user facing, application or system. We are delivering parts of a solution and it is necessity to explain an idea behind the code. This enables other engineers to create more efficient systems.
What is more, I do not expect to receive a full blown word document each time. Describing simple algorithms in few sentences of a readme, uml diagram or presentation is often enough.
Providing an explanation why we did things certain way is a part of engineering work.