"Effective Documentation for Open Source Projects"

SFNode.
San Francisco, California.
January 2019.

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

Slides

Useful Links