Upgrade to Pro — share decks privately, control downloads, hide ads and more …

FOSS DOCS 101 (keep it simple, present!)

FOSS DOCS 101 (keep it simple, present!)

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


July 24, 2015

More Decks by thatdocslady

Other Decks in Technology


  1. EuroPython 2015 | MIKEY ARIEL times are a' changing... Documentation

    is a key component of successful software Documentation is an afterthought of software delivery
  2. EuroPython 2015 | MIKEY ARIEL how documentation helps Unified and

    intuitive user experience Portable and adoptable workflow Scalable and adaptable project
  3. EuroPython 2015 | MIKEY ARIEL join the docs club Content

    Strategy DevOps for Docs Community Engagement
  4. EuroPython 2015 | MIKEY ARIEL DevOps for Docs continuous integration

    automation content curation iterative authoring unified toolchain
  5. EuroPython 2015 | MIKEY ARIEL docs or it didn't happen

    (even when nobody got time for that)