Session: Documenting Open Source: Tips, Tricks, Templates
72% of surveyed developers say “Established policies and documentation” is a key decision factor when choosing open source
93% of surveyed developers say “Incomplete or outdated documentation is a pervasive problem” in open source
“Lack of documentation” was the top reason developers gave for deciding against using an open source project
In this talk, you’ll learn some ways to get started with open source documentation, whether for your own projects or projects you’d like to contribute to, including:
- friction logs: turn your ignorance into valuable documentation
- what’s a docs audit and how would you do one?
- templates: the secret sauce for project documentation
- so you need a static site … intro to Docsy.dev, the Hugo static site theme created for OSS project documentation
As a documentarian, you can make a tremendous impact on just about any open source project, while building valuable OSS skills and a track record of key contributions (and you don’t have to be a great writer — just an enthusiastic one)!