Good docs help people use your work, but they have other benefits too. They encourage community contributions. They save you from your past self when you’re revisiting your own code six months from now. And they help you think: much like talking to a rubber duck helps you find bugs, carefully documenting your work for users helps you see it from a different perspective and design better code.
Yesterday morning, the ProPublica apps team released a series of documents outlining their coding philosophy, app design and development practices, data validation techniques, and more. We spoke with Scott Klein about how his team’s processes evolved and how they made the time to document it all.
News startups in and around Georgia helped improve search in Newscoop content management system using Solr.