Upgrade to Pro — share decks privately, control downloads, hide ads and more …

How to Write Great Documentation - Lessons Lear...

WooConf
October 20, 2017

How to Write Great Documentation - Lessons Learned From WooCommerce.com | Kat Christofer

WooConf

October 20, 2017
Tweet

More Decks by WooConf

Other Decks in Programming

Transcript

  1. 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
  2. GET READY TO ROCK A. WHERE > SITE > TYPES

    B. HOW TO PRESENT DOC > UX > TEMPLATES
  3. GET READY TO ROCK A. WHERE > SITE > TYPES

    B. HOW TO PRESENT DOC > UX > TEMPLATES C. HOW TO PRESENT CONTENT > STYLE GUIDE
  4. 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
  5. WRITING A GREAT DOC ▸ Clear ▸ Consistent ▸ Empathetic

    ▸ Helpful ▸ Pithy ▸ Specific > Go to: ▸ Comprehensive ▸ Plain Language > Enables Translation
  6. 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
  7. TAKING A GREAT SCREENSHOT ▸ High quality ▸ Consistent -

    Theme, App, Arrows ▸ Context ▸ Current ▸ Complete but conservative > Audience/Mobile ▸ Alternative: Jetpack
  8. ‣ 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
  9. ‣ PROCESS USED AT WOO 1. PRODUCT TESTING 2. USE

    THE DOC 3. REVISE 4. REPEAT 5. REVISE AGAIN STEPS
  10. METHODS AND SOURCES ▸ SUPPORT TEAM ▸ USER FEEDBACK ▸

    RELEASE TRACKING ▸ CHANNEL ▸ DATA > PROACTIVE
  11. 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