Documentation is broken

As we do it today, documentation does a poor job of helping engineers understand a codebase. Introducing: Continuous Documentation.

Engineers encounter new code all the time – when starting a new job, shifting between projects, and with almost every code review. Getting into new code is a challenging task. Yet, developers often face new code without aid – causing frustration and roadblocks in the development flow.

One possible solution would be internal code documentation, but the way engineering teams approach documentation today is broken. If documentation does exist, it is almost always outdated and never found when needed.

I’d like to propose a new way of thinking about documentation, one where it’s continuous and code-coupled.

Join LeadDev.com for free to access this content