documentation (best practices)
These manuals go large.
In 1951, Bell Telephone System introduced a guide titled "The Telephone and How We Use It," designed to aid elementary school students and others in understanding the operation of classic rotary dial phones. The guide detailed everything from basic phone use, handling emergencies, to polite phone ma
This post shows how you can use the notes command in Rails to search through your codebase for comments starting with a specific keyword. By default, it searches the codebase for FIXME, OPTIMIZE, and TODO comments, but you can also configure it to use custom keywords.
Patience and empathy are the basis of good documentation, much as they are the basis for being a decent person. Here's a how-to for creating better open source project docs, which can help your users and grow your community.
Find the software documentation system for Divio. Includes comprehensive tutorials, how-to guides, technical reference and explanation. Learn more here.
Three documents I write (one-pager, design doc, after-action review) and how I structure them.