Presented on May 23, 2016 at Write the Docs North America 2016

Photo by Write the Docs is licensed under CC BY-NC-SA 2.0

I gave a talk on writing better README files at the Write the Docs North America conference held in Portland, Oregon in May 2016. If you attended the talk, I hope you enjoyed it! If you were unable to attend, you can watch a recording of Write the Readable README on YouTube.

Here are some of the things I mentioned in my talk:

• GitHub search for repositories with 10,000 or more stars
• My README checklist
• Phrasal template word games Mad Libs
• Appropriate Uses for SQLite, particularly the section Situations Where A Client/Server RDBMS May Work Better
• Contributing Guides: A Template by Nadia Eghbal

If you're desperate to revisit my slides, then you can download a PDF.

Reception

If you liked this, then subscribe to get updates on making documentation, tech writing, and docs as code. When you sign up, you’ll also get The 30-Minute Information Rescue, a short guide to interviewing subject matter experts when there’s no time to spare.

Subscribe

Subscribe for periodic articles and offers. I won’t sell, rent, or give away your personal information. Unsubscribe at any time. Read my privacy policy for details.

Don’t want more email? Subscribe to my RSS feed instead.