create great user documents for word press
DESCRIPTION
Creating a multiple learning channel improves the learning experience of WordPress users. Ideas, tips & case study for the increase theme and plugin developers.TRANSCRIPT
![Page 1: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/1.jpg)
Create GreatUser Documents
by Gloria AntonelliWordCamp Chicago 2013
for Theme & Plugins Developers
![Page 2: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/2.jpg)
about me artistdesignertechnologisttrainerconsultantweb strategistwordpress developer
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 3: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/3.jpg)
stuff i know
htmlcss
phpwordpress
web standards
uxuiseographic designcontent strategyusability testinginformation architecture
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 4: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/4.jpg)
long tail of WP usersdocumentation culturedoc types for learningwriting tipsvisual presentation tipsinstructional presentation tipsfindabilityuser interfacedoc sprintscase studies
learning channel overview
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 5: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/5.jpg)
Improving WordPress Themes & Plugins Support Documentation
By Gloria Antonelli
Video available on WordPress.TVSlides available on Slideshare.net
The conversation started at WPChicago 2011.
![Page 6: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/6.jpg)
documentation
developmentdesigndocumentation
WP GOLD STANDARDS
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 7: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/7.jpg)
new & non tech users
expe
rien
ced
user
s
The Learning Curve
Difficult
Easy
Long Tail of WP Users
Unlimited nichewith limited skill.
![Page 8: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/8.jpg)
Multiple Learning Layers
Essential Advanced WordPress Admin UI HTML5 Theme Functionality CSS3 Theme Options PHP Theme Widgets JQUERY
“Learn” image Aaron Schmidthttp://www.flickr.com/photos/aaronschmidt/
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 9: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/9.jpg)
Buried in support requests?
A great learning center can transform your business.
http://flic.kr/p/dqKrEJ
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 10: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/10.jpg)
Stand out in the Market Place Decrease Support Requests
Increase Customer Satisfaction
Increase Your Happiness Level
http://flic.kr/p/
![Page 11: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/11.jpg)
Users select themes & plugins by learning
channel quality.
![Page 12: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/12.jpg)
Documentation Culture
![Page 13: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/13.jpg)
Your Job
Provide instructional information to users.
Document development time up front or pay on the back end with support time.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 14: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/14.jpg)
Improve Users Productivity
Identify your user goals & learning outcomes.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 15: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/15.jpg)
http://www.flickr.com/photos/lac-bac/7509282230/
Provide Road Maps
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 16: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/16.jpg)
Road Blocks
Users have different skill sets, technical expertise, and learning styles.
No single format works for everyone.
Provide multiple learning channels for success.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 17: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/17.jpg)
Learning Doc Types Topical GuidesTutorials Reference Guides
How to’s System Requirements Knowledge Base
Step by Step Infographics eBook/WhitePaper
Screencast Code Snippets Trouble Shooting
Webinars Deep-Dive Manual
Videos Start Guides FAQ
Offer multiple optionsfor learning.
Offer multiple optionsfor learning.
GlossaryOffer multiple optionsfor learning.
Offer multiple optionsfor learning. Overviews
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 18: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/18.jpg)
Infographics
http://marktimemedia.com/redesigning-the-template-hierarchy/
![Page 19: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/19.jpg)
ForumsSometimes good & sometimes not good.
Many Theme companies are closing forums and moving to ticketed support systems.
![Page 20: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/20.jpg)
Start Here
![Page 22: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/22.jpg)
Then Edit
Most docs don’t go beyond a rough draft.
http://flic.kr/p/7DhKhD
![Page 23: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/23.jpg)
http://flic.kr/p/6wPQhm
edit on paper
read slowly read out loud
review 3X
Successful Editing
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 24: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/24.jpg)
Writing TipsTarget each audience group.
Act like a personal instructor.
Be conversational.
Be brief, clear, concise, & helpful.
Write short paragraphs & omit fluff.
Don’t buried important info in a wall of text.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 25: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/25.jpg)
Visual Presentation TipsCreate a documentation style guide.
Chunk instructional content.
Use tables & lists.
Use callouts.
Format for scanning.
Use header hierarchy.
Use color coding.
Use white space for readability.
![Page 26: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/26.jpg)
Instructional TipsBreak down into step by step instructions.
Create new tutorials from forum conversations.
Provide written content for videos.
Include clarification of terminology.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 27: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/27.jpg)
Anticipate Questions
1. Write down real questions.
2. Develop detailed instructions to answer the question.
3. Plug into learning channel.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 28: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/28.jpg)
Findability
Table of Content
Site Map
Index
http://flic.kr/p/7PTDDm
ability to locate and present usable information easily, accurately, and quickly as possible.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 30: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/30.jpg)
Doc Sprints
Collaborative Document Sprints are a good fit for technical documentation.Sprints organize people to write documentation in a few days - same location or multiple time zones.
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 31: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/31.jpg)
Documents should not be behind a walled garden.
Garden WallBy join the dots
![Page 32: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/32.jpg)
http://www.flickr.com/photos/dillemma/8740718365/
Information Architecture
![Page 33: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/33.jpg)
IA categorization of information into a coherent structure.
Arrange for Importance or Skill Level
Start Here Call of Actions
Descriptive Headers
Site Map & Topic Overviews
GroupTopics
WordCamp Chicago 2013@GloriaAntonelli #WCCHI
![Page 34: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/34.jpg)
verify content & code
learners skills & abilities
iterate, iterate, iterate
EvaluationAssessment
Modifications
http://flic.kr/p/L5v2U
![Page 35: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/35.jpg)
Time for Updates
Continual Document Review
http://flic.kr/p/4PeAb
![Page 36: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/36.jpg)
Easy Docs Theme
![Page 37: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/37.jpg)
![Page 38: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/38.jpg)
Obox - an example of multiple leaning channels
http://kb.oboxsites.com/
Disclaimer: A review of the learning channels layout not of Obox theme quailty.
![Page 39: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/39.jpg)
Obox
![Page 40: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/40.jpg)
![Page 41: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/41.jpg)
Obox
![Page 42: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/42.jpg)
Obox
![Page 43: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/43.jpg)
Obox
![Page 44: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/44.jpg)
Obox
![Page 45: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/45.jpg)
Obox
![Page 46: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/46.jpg)
Obox
![Page 47: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/47.jpg)
No clear path to the plugin information.http://yoast.com/wordpress/seo/
![Page 48: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/48.jpg)
An example of a clear path of learning.
![Page 49: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/49.jpg)
Join the
WordPress Global
Community
![Page 50: Create Great User Documents for Word Press](https://reader033.vdocuments.us/reader033/viewer/2022061300/54c720c94a7959e16f8b458f/html5/thumbnails/50.jpg)
thank you!Gloria Antonelli
@GloriaAntonelligoogle +linkedinfacebook
Emerging Technology& Web Strategist WordPress Developer Consultant & Trainer