"Effective Documentation for Open Source Projects"
Abstract
Documentation is critical in creating a successful open source project, yet it can be hard to know where to start.
How do you organize your docs? What sections do you need? How much detail should you add? What baseline knowledge can you assume your audience has? This talk will walk you through how and why to document a typical JavaScript module in npm for the browser or Node.js
Video
Slides
Useful Links
This is the repository used for all of the examples in the talk and demonstrates many of the concepts discussed.
In this talk, I only discussed one of several types of documentation needed for a good open source project. GitHub has created a great guide to running an open source project where they talk about the many parts needed to run a successful open source project. Many of these parts are documentation oriented, from the technical documentation discussed in this talk, to other forms of documentation that are just as important.