Download to read offline
Uploaded byGloria Antonelli
Create Great User Documents for Word Press
Gloria Antonelli's presentation at WordCamp Chicago 2013 focuses on creating effective user documentation for WordPress themes and plugins. She emphasizes the importance of understanding user needs, providing multiple learning channels, and enhancing documentation through clear, concise writing and visual presentation. The document also discusses strategies for improving user productivity and decreasing support requests through well-structured documentation.
![Accessibility with Joomla [on a budget]](https://cdn.slidesharecdn.com/ss_thumbnails/joomla-accessibility-141123061021-conversion-gate01-thumbnail.jpg?width=640&height=640&fit=bounds)
Create Great User Documents for Word Press
- 1. Create Great User Documents byGloria Antonelli WordCamp Chicago 2013 forTheme & Plugins Developers
- 2. about me artist designer technologist trainer consultant web strategist wordpressdeveloper WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 3. stuff i know html css php wordpress webstandards ux ui seo graphic design content strategy usability testing information architecture WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 4. long tail ofWP users documentation culture doc types for learning writing tips visual presentation tips instructional presentation tips findability user interface doc sprints case studies learning channel overview WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 5. Improving WordPress Themes &Plugins Support Documentation By Gloria Antonelli Video available on WordPress.TV Slides available on Slideshare.net The conversation started at WPChicago 2011.
- 6. development design documentation WP GOLD STANDARDS WordCampChicago 2013 @GloriaAntonelli #WCCHI
- 7. new & nontech users experiencedusers The Learning Curve Difficult Easy Long Tail of WP Users Unlimited niche with limited skill.
- 8. Multiple Learning Layers EssentialAdvanced WordPress Admin UI HTML5 Theme Functionality CSS3 Theme Options PHP Theme Widgets JQUERY “Learn” image Aaron Schmidt http://www.flickr.com/photos/aaronschmidt/ WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 9. Buried in supportrequests? A great learning center can transform your business. http://flic.kr/p/dqKrEJ WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 10. Stand out inthe Market Place Decrease Support Requests Increase Customer Satisfaction IncreaseYour Happiness Level http://flic.kr/p/
- 11. Users select themes &plugins by learning channel quality.
- 12.
- 13. Your Job Provide instructional informationto users. Document development time up front or pay on the back end with support time. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 14. Improve Users Productivity Identifyyour user goals & learning outcomes. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 15. http://www.flickr.com/photos/lac-bac/7509282230/ Provide Road Maps WordCampChicago 2013 @GloriaAntonelli #WCCHI
- 16. Road Blocks Users havedifferent skill sets, technical expertise, and learning styles. No single format works for everyone. Provide multiple learning channels for success. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 17. Learning Doc Types TopicalGuidesTutorials 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 options for learning. Offer multiple options for learning. GlossaryOffer multiple options for learning. Offer multiple options for learning. Overviews WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 18.
- 19. Forums Sometimes good & sometimesnot good. Many Theme companies are closing forums and moving to ticketed support systems.
- 20.
- 21.
- 22. Then Edit Most docsdon’t go beyond a rough draft. http://flic.kr/p/7DhKhD
- 23. http://flic.kr/p/6wPQhm edit on paper readslowly read out loud review 3X Successful Editing WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 24. Writing Tips Target eachaudience 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
- 25. Visual Presentation Tips Createa 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.
- 26. Instructional Tips Break downinto step by step instructions. Create new tutorials from forum conversations. Provide written content for videos. Include clarification of terminology. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 27. Anticipate Questions 1. Writedown real questions. 2. Develop detailed instructions to answer the question. 3. Plug into learning channel. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 28. Findability Table of Content SiteMap Index http://flic.kr/p/7PTDDm ability to locate and present usable information easily, accurately, and quickly as possible. WordCamp Chicago 2013 @GloriaAntonelli #WCCHI
- 29.
- 30. Doc Sprints Collaborative DocumentSprints 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
- 31. Documents should notbe behind a walled garden. Garden WallBy join the dots
- 32.
- 33. IA categorization ofinformation 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
- 34. verify content &code learners skills & abilities iterate, iterate, iterate Evaluation Assessment Modifications http://flic.kr/p/L5v2U
- 35. Time for Updates ContinualDocument Review http://flic.kr/p/4PeAb
- 36.
- 38. Obox - anexample of multiple leaning channels http://kb.oboxsites.com/ Disclaimer:A review of the learning channels layout not of Obox theme quailty.
- 39.
- 41.
- 42.
- 43.
- 44.
- 45.
- 46.
- 47. No clear pathto the plugin information. http://yoast.com/wordpress/seo/
- 48. An example ofa clear path of learning.
- 49.
- 50. thank you! Gloria Antonelli @GloriaAntonelli google + linkedin facebook EmergingTechnology & Web Strategist WordPress Developer Consultant & Trainer gloria@gloriaantonelli.com