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
Slide 2
Slide 2 text
who am I?
Slide 3
Slide 3 text
why am I here?
Slide 4
Slide 4 text
documentation matters!
(to me, to you, and you, and you...)
Slide 5
Slide 5 text
times are a' changing...
Documentation is a key component of
successful software
Documentation is an afterthought of
software delivery
Slide 6
Slide 6 text
how documentation helps
Unified and intuitive
user experience
Portable and adoptable
workflow
Scalable and adaptable
project
Slide 7
Slide 7 text
join the docs club
Content Strategy
DevOps for Docs
Community Engagement
Slide 8
Slide 8 text
asking the right questions
(even if the answer is as simple as 42)
Slide 9
Slide 9 text
WHO
are my readers?
Slide 10
Slide 10 text
WHAT
do my readers want to know?
Slide 11
Slide 11 text
WHEN
do my readers need this content?
Slide 12
Slide 12 text
WHERE
do my readers consume this content?
Slide 13
Slide 13 text
WHY
do my readers even need this content?
Slide 14
Slide 14 text
GNOME help
Slide 15
Slide 15 text
GNOME help
Slide 16
Slide 16 text
GNOME help
Slide 17
Slide 17 text
GNOME help
Slide 18
Slide 18 text
GNOME help
Slide 19
Slide 19 text
archlinux wiki
Slide 20
Slide 20 text
archlinux wiki
Slide 21
Slide 21 text
archlinux wiki
Slide 22
Slide 22 text
RHEL OpenStack
Slide 23
Slide 23 text
before...
Slide 24
Slide 24 text
before...
Slide 25
Slide 25 text
before...
Slide 26
Slide 26 text
before...
???
Slide 27
Slide 27 text
… after!
Slide 28
Slide 28 text
… after!
Slide 29
Slide 29 text
… after!
Slide 30
Slide 30 text
DevOps for Docs
(not just for developers anymore!)
Slide 31
Slide 31 text
DevOps
for Docs
unified
toolchain
Slide 32
Slide 32 text
universal platform
Slide 33
Slide 33 text
standardized review flow
Slide 34
Slide 34 text
live preview
Slide 35
Slide 35 text
out-of-the-box publication
Slide 36
Slide 36 text
DevOps
for Docs
continuous
integration
unified
toolchain
Slide 37
Slide 37 text
automatic builds
Slide 38
Slide 38 text
continuous staging
Slide 39
Slide 39 text
DevOps
for Docs
continuous
integration
automation
unified
toolchain
Slide 40
Slide 40 text
sanity checks
Slide 41
Slide 41 text
unit tests
Slide 42
Slide 42 text
DevOps
for Docs
continuous
integration
Iterative
authoring
automation
unified
toolchain