Speaker Deck

FOSS DOCS 101 (keep it simple, present!)

by thatdocslady

Published July 24, 2015 in Technology

WATCH THE VIDEO HERE: https://www.youtube.com/watch?v=FopnpwK6ALw

Does your open source project need better documentation? Do you wish that new users could get started with your software more easily? Do you feel that your code contribution workflow isn’t documented well enough, or that contributors are discouraged from documenting their code? How can you give your project docs the love they deserve?

This high-level talk aims to introduce the main principles of technical communication in the context of FOSS projects. It is intended for anyone who interacts with documentation, whether your project is fresh off the dev environment or has been around since the dawn of Git. Topics include content strategy and planning, infrastructure and information management, and community contribution and engagement.

Presented at EuroPython 2015: https://ep2015.europython.eu/conference/talks/foss-docs-101-keep-it-simple-present