Writing Better Developer Documentation

When open-source projects don’t have good documentation, most people don’t use them but this is not an option when you have to use the code developed with other teams within your own company. Then, you have to use it and the lack of documentation can lead to frustration and even desperation. Why doesn’t good internal documentation exist? The problem is threefold:

If you understand everything it is hard to know what is confusing to others

If you don’t know things, you know what you wish existed but you can’t write it yourself

Even if you have both people present, it is still hard to write good documentation

In this session, I will show you how to solve all three problems.

About Llewellyn Falco

Llewellyn Falco is an independent agile coach. He discovered strong-style pair programming. He is creator of the open source testing tool ApprovalTests( www.approvaltests.com ). He spends most of his time programming in Java and C# specializing in improving legacy code.He is the co-founder of TeachingKidsProgramming.org & co-author of Mob Programming Guidebook

More About Llewellyn  »