WHY AND HOW
TO CREATE DOCS THAT ROCK
KAT CHRISTOFER
Slide 2
Slide 2 text
No content
Slide 3
Slide 3 text
OUTLINE
‣ I: TRUTH ABOUT DOCS
‣ II: WHAT MAKES A GREAT DOC
‣ III: HOW TO CREATE DOCS THAT ROCK
‣ IV: TEST YOUR DOC
‣ V: HOW TO MAINTAIN DOCS
Slide 4
Slide 4 text
SEXY
SUPER FUN
CUTE & CUDDLY
TRUTH
Slide 5
Slide 5 text
SUPPORT
RESOURCES
GROWTH
EMPOWERMENT
- USERS
- TEAM
NOW
ALSO TRUE
Slide 6
Slide 6 text
WHAT
MAKES A
GREAT DOC
Slide 7
Slide 7 text
GET READY TO ROCK
A. WHERE > SITE > TYPES
B. HOW TO PRESENT DOC > UX > TEMPLATES
Slide 8
Slide 8 text
No content
Slide 9
Slide 9 text
No content
Slide 10
Slide 10 text
GET READY TO ROCK
A. WHERE > SITE > TYPES
B. HOW TO PRESENT DOC > UX > TEMPLATES
C. HOW TO PRESENT CONTENT > STYLE GUIDE
Slide 11
Slide 11 text
No content
Slide 12
Slide 12 text
No content
Slide 13
Slide 13 text
No content
Slide 14
Slide 14 text
GET READY TO ROCK
A. WHERE > SITE > TYPES
B. HOW TO PRESENT DOC > UX > TEMPLATES
C. HOW TO PRESENT CONTENT > STYLE GUIDE
D. WHAT TO WRITE
Slide 15
Slide 15 text
WRITING A GREAT DOC
▸ Clear
▸ Consistent
▸ Empathetic
▸ Helpful
▸ Pithy
▸ Specific > Go to:
▸ Comprehensive
▸ Plain Language > Enables Translation
Slide 16
Slide 16 text
No content
Slide 17
Slide 17 text
GET READY TO ROCK
A. WHERE > SITE > TYPES
B. HOW TO PRESENT DOC > UX > TEMPLATES
C. HOW TO PRESENT CONTENT > STYLE GUIDE
D. WHAT TO WRITE
E. WHAT TO SHOW > SCREENSHOTS
Slide 18
Slide 18 text
TAKING A GREAT SCREENSHOT
▸ High quality
▸ Consistent - Theme, App, Arrows
▸ Context
▸ Current
▸ Complete but conservative > Audience/Mobile
▸ Alternative: Jetpack
Slide 19
Slide 19 text
HOW TO
CREATE A
GREAT DOC
Slide 20
Slide 20 text
‣ TECHNICAL EDITING - JUDY TARUTZ
‣ INSIDER’S GUIDE TO TECH WRITING -
VAN LAAN & HACKOS
‣ READ THIS FIRST - SUN TECHNICAL
1. ORGANIZE - STRATEGIZE
2. OUTLINE > DRAFT
3. ADD IMAGES
4. PREVIEW/REVIEW
5. PROOFREAD
STEPS
Slide 21
Slide 21 text
NOT WRITING DOCS?
HIRE SOMEONE.
INVESTMENT IS WORTH IT LONG TERM.
Write the Docs
TEXT
Slide 22
Slide 22 text
TEST
YOUR DOC
Slide 23
Slide 23 text
‣ PROCESS USED AT WOO
1. PRODUCT TESTING
2. USE THE DOC
3. REVISE
4. REPEAT
5. REVISE AGAIN
STEPS
Slide 24
Slide 24 text
HOW TO
MAINTAIN
AND UPDATE
DOCS
Slide 25
Slide 25 text
METHODS AND SOURCES
▸ SUPPORT TEAM
▸ USER FEEDBACK
▸ RELEASE TRACKING
Slide 26
Slide 26 text
No content
Slide 27
Slide 27 text
No content
Slide 28
Slide 28 text
METHODS AND SOURCES
▸ SUPPORT TEAM
▸ USER FEEDBACK
▸ RELEASE TRACKING
▸ CHANNEL
▸ DATA > PROACTIVE
Slide 29
Slide 29 text
No content
Slide 30
Slide 30 text
RESOURCES
WOO DOCS
https://docs.woocommerce.com/
TEMPLATES
Payment Gateway https://docs.woocommerce.com/document/docs-template-payment-gateway/
Extension/Add-on https://docs.woocommerce.com/document/docs-template-extension/
WOO STYLE & WRITING GUIDE
https://woostyleguide.wordpress.com/ To be made public when Marketplace opens to new devs
BOOKS
Technical Editing by Judy Tarutz
Insider’s Guide to Technical Writing by Kristan Van Laan
Read This First Sun Technical
Write the Docs community and resources http://www.writethedocs.org/
HOW TO CONTACT
WordPress Slack @californiakat
GitHub @californiakat
Twitter @katchristofer