DEV Community


Discussion on: How to write good documentation

mochadwi profile image
Mochamad Iqbal Dwi Cahyo • Edited

Does coding documentation is violates clean codes?

How to encourage our teams to write documentation also to avoid excuses similar like below.

"Clean code is code without comments" or sometimes "We don't have time to create UMLs & diagram also the software spec docs" etc so on

Please any suggestion or advice?

phlash909 profile image
Phil Ashby

Something I've seen work is supporting people to change teams, they get to experience the newbie ramp-up more often and appreciate good docs, rather than living their own codebase for years and becoming the single point of expertise..