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

FOSS DOCS 101

FOSS DOCS 101

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.

This deck reflects the presentation as delivered at Django Under the Hood 2015 conference: https://public.pad.fsfe.org/p/docs-under-the-hood-workshop

thatdocslady

November 07, 2015
Tweet

More Decks by thatdocslady

Other Decks in Technology

Transcript

  1. Mikey Ariel Mikey Ariel @ThatDocsLady | @WriteTheDocs @ThatDocsLady | @WriteTheDocs

    Django Under the Hood, November 2015 Django Under the Hood, November 2015 FOSS DOCS 101 FOSS DOCS 101
  2. times are a' changing... Documentation is a key component of

    successful software Documentation is an afterthought of software delivery
  3. how documentation helps Unified and intuitive user experience Portable and

    adoptable workflow Scalable and adaptable project