foss docs 101...foss docs 101 mikey ariel senior technical writer, red hat europython, july 2015...

FOSS DOCS 101

Mikey ArielSenior technical writer, Red Hat

EuroPython, July 2015

EuroPython 2015 | MIKEY ARIEL

who am I?

EuroPython 2015 | MIKEY ARIEL

why am I here?

EuroPython 2015 | MIKEY ARIEL

documentation matters!(to me, to you, and you, and you...)

EuroPython 2015 | MIKEY ARIEL

times are a' changing...

Documentation is a key component of successful software

Documentation is an afterthought of software delivery

EuroPython 2015 | MIKEY ARIEL

how documentation helps

Unified and intuitiveuser experience

Portable and adoptable workflow

Scalable and adaptable project

EuroPython 2015 | MIKEY ARIEL

join the docs club

Content Strategy

DevOps for Docs

Community Engagement

EuroPython 2015 | MIKEY ARIEL

asking the right questions(even if the answer is as simple as 42)

EuroPython 2015 | MIKEY ARIEL

WHO

are my readers?

EuroPython 2015 | MIKEY ARIEL

WHAT

do my readers want to know?

EuroPython 2015 | MIKEY ARIEL

WHEN

do my readers need this content?

EuroPython 2015 | MIKEY ARIEL

WHERE

do my readers consume this content?

EuroPython 2015 | MIKEY ARIEL

WHY

do my readers even need this content?

EuroPython 2015 | MIKEY ARIEL

GNOME help

EuroPython 2015 | MIKEY ARIEL

GNOME help

EuroPython 2015 | MIKEY ARIEL

GNOME help

EuroPython 2015 | MIKEY ARIEL

GNOME help

EuroPython 2015 | MIKEY ARIEL

GNOME help

EuroPython 2015 | MIKEY ARIEL

archlinux wiki

EuroPython 2015 | MIKEY ARIEL

archlinux wiki

EuroPython 2015 | MIKEY ARIEL

RHEL OpenStack

EuroPython 2015 | MIKEY ARIEL

RHEL OpenStack

???

EuroPython 2015 | MIKEY ARIEL

DevOps for Docs(not just for developers anymore!)

EuroPython 2015 | MIKEY ARIEL

DevOps for Docs

continuous integration

automation

content curation

iterative authoring

unified toolchain

EuroPython 2015 | MIKEY ARIEL

docs or it didn't happen(even when nobody got time for that)

EuroPython 2015 | MIKEY ARIEL

EuroPython 2015 | MIKEY ARIEL

contribution guidelines

EuroPython 2015 | MIKEY ARIEL

NixOS

EuroPython 2015 | MIKEY ARIEL

templates

EuroPython 2015 | MIKEY ARIEL

Read the Docs

EuroPython 2015 | MIKEY ARIEL

collaboration and training

EuroPython 2015 | MIKEY ARIEL

sprints and hackfests

EuroPython 2015 | MIKEY ARIEL

conferences and communities

EuroPython 2015 | MIKEY ARIEL

welcome to the club!

THANK YOU!

mariel@redhat.com@thatdocslady