Description

Documenting code is an important task that few teams get right. Docs get easily outdated, everybody hates writing them and sometimes developers don’t even use them at all.

In this talk, you will learn about an approach to documentation writing based on adding comments directly to the source code. I will show you its benefits applied to three different types of codebases.

You will also learn how to generate documentation from those same comments in two different flavors as well as when each of them works best.

Links

• Slides
• Recording