December 6-8, 2017 - Austin, Texas
Click Here for More Information + Registration 

Customize your schedule by session topic and skill level:
Session Topic - Refer to the "Type" filter list to the right to find a session based on topic. Talk Difficulty - Sessions are categorized as [B]eginner, [I]ntermediate or [A]dvanced at the end of each talk title. No letter indicates an “Any” level. 
View analytic
Wednesday, December 6 • 2:00pm - 2:35pm
The Art of Documentation and Readme.md for Open Source Projects - Ben Hall, Katacoda

Sign up or log in to save this to your schedule and see who's attending!

The Readme is becoming essential to successful Open Source projects. The Readme is a gateway to welcoming new users and potential contributors. It defines the tone of the project, how to get started and most importantly, the aim.

While many Open Source projects have amazing code-bases, the Readme and documentation are letting them down and as a result they are losing influence and opportunities for adoption and feedback.

In this talk, Ben uses his expertise of building an Interactive Learning Platform to highlight The Art of Documentation and the Readme file. The aim of the talk is to help open source contributors understand how small changes to their documentation approach can have an enormous impact on how users get started.

Ben will discuss:
- How to create engaging documentation
- Defining technical details in an accessible way
- Building documentation that encourages users to get started
- How to manage documentation and keeping it up-to-date and relevant

In the end, attendees will have an understanding of how to build beautiful, useful documentation. This will be backed by examples from some of the best open source projects.

avatar for Ben Hall

Ben Hall

Founder, Katacoda
Ocelot Uproar is the creator behind Katacoda (Katacoda.com), an interactive learning platform for software engineers. Ben tweets at @Ben_Hall while blogging at blog.benhall.me.uk.

Wednesday December 6, 2017 2:00pm - 2:35pm
Meeting Room 10AB, Level 3

Attendees (212)