Tweet
Tweet

Slide 1

Slide 1 text

DOCS OR IT DIDN’T HAPPEN! (with Q&A) Mikey Ariel @ThatDocsLady @WriteTheDocs DjangoCon Europe, April 2019

Slide 2

Slide 2 text

Why are we here? The Q&A section will include first questions that were collected in advance from Twitter, and then questions collected during the talk from Slack and moderated by the host. Please ask responsibly! If you have a question or need some help with your documentation, please come and find me during the conference! You can also 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

Goal-Oriented Docs

Slide 16

Slide 16 text

Why Who Need-to-Know Documentation

Slide 17

Slide 17 text

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

Slide 18

Slide 18 text

GNOME Help help.gnome.org Users Developers Administrators

Slide 19

Slide 19 text

Why What Who Need-to-Know Documentation

Slide 20

Slide 20 text

Minishift README github.com/minishift/minishift

Slide 21

Slide 21 text

Why When What Who Need-to-Know Documentation

Slide 22

Slide 22 text

Arch Linux Wiki wiki.archlinux.org

Slide 23

Slide 23 text

Arch Linux Wiki wiki.archlinux.org

Slide 24

Slide 24 text

Why Where When What Who Need-to-Know Documentation

Slide 25

Slide 25 text

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

Slide 26

Slide 26 text

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

Slide 27

Slide 27 text

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

Slide 28

Slide 28 text

Why Where When What Who Need-to-Know Documentation

Slide 29

Slide 29 text

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

Slide 30

Slide 30 text

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

Slide 31

Slide 31 text

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

Slide 32

Slide 32 text

Hierarchical Source Content github.com/minishift/minishift

Slide 33

Slide 33 text

Issue Tracking github.com/minishift/minishift

Slide 34

Slide 34 text

Issue Tracking github.com/minishift/minishift

Slide 35

Slide 35 text

CONTINUOUS PUBLICATION No need to stop the press anymore!

Slide 36

Slide 36 text

Publication Tools

Slide 37

Slide 37 text

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

Slide 38

Slide 38 text

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

Slide 39

Slide 39 text

TESTING AUTOMATION More than a just a spell-checker!

Slide 40

Slide 40 text

Code Blocks Validation github.com/endocode/shelldoc

Slide 41

Slide 41 text

Linguistic Validation www.hemingwayapp.com

Slide 42

Slide 42 text

Test Automation Framework github.com/emender/emender

Slide 43

Slide 43 text

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

Slide 44

Slide 44 text

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

Slide 45

Slide 45 text

Django Project Linux Kernel OpenStack Documentation as a Deliverable

Slide 46

Slide 46 text

Contribution Guides nixos.wiki/wiki/Contributing_to_Nix_documentation

Slide 47

Slide 47 text

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

Slide 48

Slide 48 text

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

Slide 49

Slide 49 text

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

Slide 50

Slide 50 text

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

Slide 51

Slide 51 text

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

Slide 52

Slide 52 text

Meet and greet more Documentarians!

Slide 53

Slide 53 text

Write the Docs

Slide 54

Slide 54 text

Doc-to-Dev Outreach Find me for a chat at the conference! (I have stickers)

Slide 55

Slide 55 text

Season of Docs developers.google.com/season-of-docs

Slide 56

Slide 56 text

Q&A Crowdsourced, anonymized, and non-weaponized questions 4

Slide 57

Slide 57 text

Grammar, Syntax, and Linguistics 1

Slide 58

Slide 58 text

Grammar, Syntax, and Linguistics 1 “Do you see benefits in using/avoiding pronouns in docs? "Property x allows you to do y" vs "Property x allows for doing y". Do you have recommendations on when which version makes more sense or is more appropriate?”

Slide 59

Slide 59 text

Grammar, Syntax, and Linguistics 1 “Do you see benefits in using/avoiding pronouns in docs? "Property x allows you to do y" vs "Property x allows for doing y". Do you have recommendations on when which version makes more sense or is more appropriate?” MINIMALISM!

Slide 60

Slide 60 text

Grammar, Syntax, and Linguistics 1 "Property x allows you to do y." "Property x allows for doing y." "With X one can do Y." "With X doing Y is possible." "With X it's possible to do Y."

Slide 61

Slide 61 text

Grammar, Syntax, and Linguistics 1 "Property x allows you to do y." "Property x allows for doing y." "With X one can do Y." "With X doing Y is possible." "With X it's possible to do Y." “You do X with Y.”

Slide 62

Slide 62 text

Grammar, Syntax, and Linguistics 1 "Property x allows you to do y." "Property x allows for doing y." "With X one can do Y." "With X doing Y is possible." "With X it's possible to do Y." ● 2nd voice (“you”) in the relevant context (persona-based docs) ● “Things” cannot “allow” humans to do things (anthropomorphism) ● Active voice indicates goal first and method second (goal-oriented wording) ● Gerunds (“*ing”) are grammatically ambiguous and hard to translate “You do X with Y.”

Slide 63

Slide 63 text

Collaboration, Contributions, and Community 2

Slide 64

Slide 64 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?”

Slide 65

Slide 65 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?” “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?”

Slide 66

Slide 66 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?” “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?” “It’s very hard for someone to write documentation for a project if they don’t know how the project works. How do you best facilitate that knowledge transfer (other than, of course, writing docs…)? How do you bootstrap the process?”

Slide 67

Slide 67 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?” “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?” “It’s very hard for someone to write documentation for a project if they don’t know how the project works. How do you best facilitate that knowledge transfer (other than, of course, writing docs…)? How do you bootstrap the process?” “I don't know what I don't know so how can I possibly know what you don't know?”

Slide 68

Slide 68 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?” “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?” “It’s very hard for someone to write documentation for a project if they don’t know how the project works. How do you best facilitate that knowledge transfer (other than, of course, writing docs…)? How do you bootstrap the process?” “I don't know what I don't know so how can I possibly know what you don't know?” TALK TO PEOPLE!

Slide 69

Slide 69 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?”

Slide 70

Slide 70 text

Collaboration, Contributions, and Community 2 “So I’ve got a project. I know I need docs. I can write, but I know it’s not my strength. What do I need to do to make it easier for someone who *does* have those skills to contribute?” ● Find people with writing experience and ask them to test your software, give you feedback, and help you build contribution guidelines ● Offer mentorship and fellowship to new contributors who can help you fix the docs but might not have programming experience (or experience with your project) ● Facilitate skill-sharing sprints or meetups where developers and writers can pair-work on documentation-related tasks

Slide 71

Slide 71 text

2 “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?” Collaboration, Contributions, and Community

Slide 72

Slide 72 text

2 “When starting a project from scratch, how does one figure out how to structure the documentation and what are the first $n things one should take care of?” ● Ask (potential) users what their workflow with your software is likely to be (day 0, 1, 2, etc) and port that knowledge over to the docs (document the UX) ● Research best practices and templates (for example, modular docs project) and look up docs for projects that you like to study how they’re organized Collaboration, Contributions, and Community

Slide 73

Slide 73 text

2 “It’s very hard for someone to write documentation for a project if they don’t know how the project works. How do you best facilitate that knowledge transfer (other than, of course, writing docs…)? How do you bootstrap the process?” “I don't know what I don't know so how can I possibly know what you don't know?” Collaboration, Contributions, and Community

Slide 74

Slide 74 text

2 “It’s very hard for someone to write documentation for a project if they don’t know how the project works. How do you best facilitate that knowledge transfer (other than, of course, writing docs…)? How do you bootstrap the process?” “I don't know what I don't know so how can I possibly know what you don't know?” ● Accepting that you have a problem is the first step in solving the problem ● Reach out to your peers, make yourself available for training and mentorship, and be kind to people who want to contribute (welcoming projects get more contributors!) ● Most writers don’t have a deeper understanding of how the code is written, but their strategic communication experience is what makes them great writers - respect that! Collaboration, Contributions, and Community

Slide 75

Slide 75 text

MOAR #QUESTIONS? (remember to ask responsibly) (I’ll also be available for 1:1 questions later)

Slide 76

Slide 76 text

@ThatDocsLady [email protected] @WriteTheDocs LET’S WRITE SOME DOCS!