The README is key to successful open source projects as a gateway to welcoming new users and potential contributors. It defines the tone of the project, explains how to get started, and most importantly, outlines the project’s aim. While many open source projects have amazing code bases, their README and documentation are not as successful. As a result, these projects are losing influence and opportunities for adoption and feedback.
Ben Hall draws on his experience building an interactive learning platform to demonstrate how small changes to your documentation approach can have an enormous impact on how users get started. You’ll leave with a better understanding of how to build beautiful, useful documentation, backed by examples from some of the best open source projects.
Ben Hall is the founder of Ocelot Uproar, a company focused on building products loved by users. Ben has worked as a systems administrator, tester, and software developer and launched several companies. He still finds the time to publish books and speak at conferences. Ben enjoys looking for the next challenges to solve, usually over an occasional beer. Ben recently launched Katacoda, an online learning environment for developers that helps break down the barriers to learning new technologies such as Docker and containers.
©2017, O'Reilly Media, Inc. • (800) 889-8969 or (707) 827-7019 • Monday-Friday 7:30am-5pm PT • All trademarks and registered trademarks appearing on oreilly.com are the property of their respective owners. • firstname.lastname@example.org