FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015...
Transcript of FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015...
![Page 1: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/1.jpg)
FOSS DOCS 101
Mikey ArielSenior technical writer, Red Hat
EuroPython, July 2015
![Page 2: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/2.jpg)
EuroPython 2015 | MIKEY ARIEL
who am I?
![Page 3: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/3.jpg)
EuroPython 2015 | MIKEY ARIEL
why am I here?
![Page 4: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/4.jpg)
EuroPython 2015 | MIKEY ARIEL
documentation matters!(to me, to you, and you, and you...)
![Page 5: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/5.jpg)
EuroPython 2015 | MIKEY ARIEL
times are a' changing...
Documentation is a key component of successful software
Documentation is an afterthought of software delivery
![Page 6: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/6.jpg)
EuroPython 2015 | MIKEY ARIEL
how documentation helps
Unified and intuitiveuser experience
Portable and adoptable workflow
Scalable and adaptable project
![Page 7: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/7.jpg)
EuroPython 2015 | MIKEY ARIEL
join the docs club
Content Strategy
DevOps for Docs
Community Engagement
![Page 8: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/8.jpg)
EuroPython 2015 | MIKEY ARIEL
asking the right questions(even if the answer is as simple as 42)
![Page 9: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/9.jpg)
EuroPython 2015 | MIKEY ARIEL
WHO
are my readers?
![Page 10: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/10.jpg)
EuroPython 2015 | MIKEY ARIEL
WHAT
do my readers want to know?
![Page 11: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/11.jpg)
EuroPython 2015 | MIKEY ARIEL
WHEN
do my readers need this content?
![Page 12: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/12.jpg)
EuroPython 2015 | MIKEY ARIEL
WHERE
do my readers consume this content?
![Page 13: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/13.jpg)
EuroPython 2015 | MIKEY ARIEL
WHY
do my readers even need this content?
![Page 14: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/14.jpg)
EuroPython 2015 | MIKEY ARIEL
GNOME help
![Page 15: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/15.jpg)
EuroPython 2015 | MIKEY ARIEL
GNOME help
![Page 16: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/16.jpg)
EuroPython 2015 | MIKEY ARIEL
GNOME help
![Page 17: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/17.jpg)
EuroPython 2015 | MIKEY ARIEL
GNOME help
![Page 18: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/18.jpg)
EuroPython 2015 | MIKEY ARIEL
GNOME help
![Page 19: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/19.jpg)
EuroPython 2015 | MIKEY ARIEL
archlinux wiki
![Page 20: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/20.jpg)
EuroPython 2015 | MIKEY ARIEL
archlinux wiki
![Page 21: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/21.jpg)
EuroPython 2015 | MIKEY ARIEL
RHEL OpenStack
![Page 22: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/22.jpg)
EuroPython 2015 | MIKEY ARIEL
RHEL OpenStack
???
![Page 23: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/23.jpg)
EuroPython 2015 | MIKEY ARIEL
DevOps for Docs(not just for developers anymore!)
![Page 24: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/24.jpg)
EuroPython 2015 | MIKEY ARIEL
DevOps for Docs
continuous integration
automation
content curation
iterative authoring
unified toolchain
![Page 25: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/25.jpg)
EuroPython 2015 | MIKEY ARIEL
docs or it didn't happen(even when nobody got time for that)
![Page 26: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/26.jpg)
EuroPython 2015 | MIKEY ARIEL
![Page 27: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/27.jpg)
EuroPython 2015 | MIKEY ARIEL
contribution guidelines
![Page 28: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/28.jpg)
EuroPython 2015 | MIKEY ARIEL
NixOS
![Page 29: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/29.jpg)
EuroPython 2015 | MIKEY ARIEL
templates
![Page 30: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/30.jpg)
EuroPython 2015 | MIKEY ARIEL
Read the Docs
![Page 31: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/31.jpg)
EuroPython 2015 | MIKEY ARIEL
collaboration and training
![Page 32: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/32.jpg)
EuroPython 2015 | MIKEY ARIEL
sprints and hackfests
![Page 33: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/33.jpg)
EuroPython 2015 | MIKEY ARIEL
conferences and communities
![Page 34: FOSS DOCS 101...FOSS DOCS 101 Mikey Ariel Senior technical writer, Red Hat EuroPython, July 2015 EuroPython 2015 | MIKEY ARIEL who am I? EuroPython 2015 | MIKEY ARIEL why am I here?](https://reader030.fdocuments.net/reader030/viewer/2022041023/5ed44fe34e1aa219885a945f/html5/thumbnails/34.jpg)
EuroPython 2015 | MIKEY ARIEL
welcome to the club!