RR 424: Documenting Your Code

SponsorsSentry use code “devchat” for $100 credit DatadogPanelDavid KimuraNate HopkinsAndrew MasonEpisode SummaryToday the panel is talking about documentation. They begin by discussing what documentation is, where it fits within an application, and if the code documents itself. They agree that documentation starts in the comments to explain what you’re doing, but if that’s your exclusive method, then a refactor is in order. They talk about where to start with documentation and different ways they’ve done it. The panel talks about the importance of documentation, especially for people just joining a team. In addition to documenting the project itself, it is important to document what different libraries do and how to interact with them. They discuss where to put this kind of documentation. They talk about documenting patterns, best practices, and procedures in addition to the ‘how to’ of a project. The conversation turns to style guidelines, what they are, and how to keep them up to date. They talk about what tools are available to generate documentation that are close to the code but outside of it that can help keep documentation up to date. The panel believes that there is a relationship between the size of your team and the necessity to document. Nate introduces the idea found in the article by Tom Preston-Werner that you should think about what you’re going to create in the code, and document it first. LinksRDocYARD  RuboCopYAMLSlimERBPrettierProntoApi.rubyonrails.orgSwaggerThoughtbot and Thoughtbot PlaybookAirBNB RubyTestdoubleHoundCIOkonetAPI BlueprintRuby on Rails API documentation guidelinesTom Preston-Werner article Readme Driven Development Follow DevChat on