Docs or it didn't happen! [FOSS North 2019]

Slide 1

Slide 1 text

DOCS OR IT DIDN’T HAPPEN! Mikey Ariel @ThatDocsLady @WriteTheDocs FOSS North, April 2019

Slide 2

Slide 2 text

Why are we here? We are *not* here to argue whether documentation is important (or to argue about anything, really). Please leave your ﬂamewars at the door, documentation is communication so let’s remember how to do that. This talk will run the full 45 minutes, with no on-stage questions. Personal interaction is recommended (ﬁnd me at the Red Hat booth!), or you can email, Slack, or tweet @ThatDocsLady with your questions any time. ◉ We want to have more users and contributors ◉ We believe (or want to believe) that docs can help ◉ is stopping us from working on docs

Slide 3

Slide 3 text

Who is That Docs Lady? @ThatDocsLady [email protected] @WriteTheDocs

Slide 4

Slide 4 text

WHAT’S ON THE MENU TODAY?

Slide 5

Slide 5 text

Content Strategy Plan a little, save a lot

Slide 6

Slide 6 text

Content Strategy Plan a little, save a lot DevOps for Docs Not just for developers anymore

Slide 7

Slide 7 text

Content Strategy Plan a little, save a lot Community Spirit We’re all in this together DevOps for Docs Not just for developers anymore

Slide 8

Slide 8 text

JOIN THE DOCUMENTARIAN CLUB!

Slide 9

Slide 9 text

“ “A documentarian is someone who cares about documentation and communication in the software industry, regardless of job title.” http:/ /www.writethedocs.org/documentarians/

Slide 10

Slide 10 text

Community Writers DevOps Testers Designers Marketing Developers Support DOCUMENTARIANS

Slide 11

Slide 11 text

CONTENT STRATEGY Asking the right questions in advance can save a lot of time later 1

Slide 12

Slide 12 text

NEED-TO-KNOW DOCS (and no, you don’t need to know everything)

Slide 13

Slide 13 text

Need-to-Know Documentation

Slide 14

Slide 14 text

Why Need-to-Know Documentation

Slide 15

Slide 15 text

Why Who Need-to-Know Documentation

Slide 16

Slide 16 text

Why What Who Need-to-Know Documentation

Slide 17

Slide 17 text

Why When What Who Need-to-Know Documentation

Slide 18

Slide 18 text

Why Where When What Who Need-to-Know Documentation

Slide 19

Slide 19 text

EXAMPLES (because screenshots are awesome)

Slide 20

Slide 20 text

GNOME Help help.gnome.org help.gnome.org

Slide 21

Slide 21 text

GNOME Help help.gnome.org

Slide 22

Slide 22 text

GNOME Help help.gnome.org

Slide 23

Slide 23 text

GNOME Help help.gnome.org

Slide 24

Slide 24 text

Arch Linux Wiki wiki.archlinux.org

Slide 25

Slide 25 text

Arch Linux Wiki wiki.archlinux.org

Slide 26

Slide 26 text

Minishift README github.com/minishift/minishift

Slide 27

Slide 27 text

Minishift Troubleshooting github.com/minishift/minishift/issues/1152

Slide 28

Slide 28 text

Minishift Troubleshooting github.com/minishift/minishift-centos-iso/pull/119

Slide 29

Slide 29 text

Minishift Troubleshooting docs.openshift.org/latest/minishift/troubleshooting/troubleshooting-misc

Slide 30

Slide 30 text

DEVOPS FOR DOCS Let’s geek out about processes, tools, and workflows, oh my! 2

Slide 31

Slide 31 text

INTEGRATION If you can’t beat them, join them!

Slide 32

Slide 32 text

Docs-as-Code github.com/minishift/minishift

Slide 33

Slide 33 text

Hierarchical Source Content github.com/minishift/minishift

Slide 34

Slide 34 text

Issue Tracking github.com/minishift/minishift

Slide 35

Slide 35 text

Issue Tracking github.com/minishift/minishift

Slide 36

Slide 36 text

CONTINUOUS PUBLICATION No need to stop the press anymore!

Slide 37

Slide 37 text

Publication Tools

Slide 38

Slide 38 text

Continuous Deployment readthedocs.org/projects/writethedocs-www/builds

Slide 39

Slide 39 text

Live-Preview Staging github.com/writethedocs/www/pulls/

Slide 40

Slide 40 text

TESTING AUTOMATION More than a just a spell-checker!

Slide 41

Slide 41 text

Code Blocks Validation github.com/endocode/shelldoc

Slide 42

Slide 42 text

Linguistic Validation www.hemingwayapp.com

Slide 43

Slide 43 text

Test Automation Framework github.com/emender/emender

Slide 44

Slide 44 text

COMMUNITY SPIRIT Let’s help our contributors help us and help each other 3

Slide 45

Slide 45 text

“ Docs or it didn’t happen! - Me, at the beginning of this presentation

Slide 46

Slide 46 text

Django Project Linux Kernel OpenStack Documentation as a Deliverable

Slide 47

Slide 47 text

Contribution Guides nixos.wiki/wiki/Contributing_to_Nix_documentation

Slide 48

Slide 48 text

Templates www.writethedocs.org/guide/writing/beginners-guide-to-docs

Slide 49

Slide 49 text

Modular Docs Project github.com/redhat-documentation/modular-docs

Slide 50

Slide 50 text

Modular Docs Project redhat-documentation.github.io/modular-docs

Slide 51

Slide 51 text

Modular Docs Project github.com/redhat-documentation/modular-docs/tree/master/modular-docs-manual/files

Slide 52

Slide 52 text

Modular Docs Project [...]/modular-docs-manual/filesTEMPLATE_PROCEDURE_doing-one-procedure.adoc

Slide 53

Slide 53 text

Community-to-Enterprise redhat-documentation.github.io/community-collaboration-guide