SlideShare ist ein Scribd-Unternehmen logo
1 von 50
Downloaden Sie, um offline zu lesen
Create Great
User Documents
by Gloria Antonelli
WordCamp Chicago 2013
forTheme & Plugins Developers
about me
artist
designer
technologist
trainer
consultant
web strategist
wordpress developer
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
stuff i know
html
css
php
wordpress
web standards
ux
ui
seo
graphic design
content strategy
usability testing
information architecture
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
long tail of WP 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
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.
development
design
documentation
WP GOLD STANDARDS
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
new & non tech users
experiencedusers
The Learning Curve
Difficult
Easy
Long Tail of WP Users
Unlimited niche
with limited skill.
Multiple Learning Layers
Essential Advanced
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
Buried in support requests?
A great learning center can
transform your business.
http://flic.kr/p/dqKrEJ
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
Stand out in the Market Place
Decrease Support Requests
Increase Customer Satisfaction
IncreaseYour Happiness Level
http://flic.kr/p/
Users select themes
& plugins by learning
channel quality.
Documentation Culture
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
Improve Users Productivity
Identify your
user goals &
learning
outcomes.
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
http://www.flickr.com/photos/lac-bac/7509282230/
Provide Road Maps
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
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
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 options
for learning.
Offer multiple options
for learning.
GlossaryOffer multiple options
for learning.
Offer multiple options
for learning. Overviews
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
Infographics
http://marktimemedia.com/redesigning-the-template-hierarchy/
Forums
Sometimes good &
sometimes not good.
Many Theme
companies are
closing forums and
moving to ticketed
support systems.
Start Here
Just Start Writing
http://flic.kr/p/DGUbY
Then Edit
Most docs don’t go beyond a rough draft.
http://flic.kr/p/7DhKhD
http://flic.kr/p/6wPQhm
edit on paper
read slowly read out loud
review 3X
Successful Editing
WordCamp Chicago 2013
@GloriaAntonelli #WCCHI
Writing Tips
Target 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
Visual Presentation Tips
Create 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.
Instructional Tips
Break 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
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
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
Doc Sprints
http://flic.kr/p/PWNcf
Collaboration
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
Documents should not be
behind a walled garden.
Garden WallBy join the dots
http://www.flickr.com/photos/dillemma/8740718365/
Information Architecture
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
verify content & code
learners skills & abilities
iterate, iterate, iterate
Evaluation
Assessment
Modifications
http://flic.kr/p/L5v2U
Time for Updates
Continual Document Review
http://flic.kr/p/4PeAb
Easy Docs Theme
Obox - an example of multiple leaning channels
http://kb.oboxsites.com/
Disclaimer:A review of the learning channels layout not of Obox theme quailty.
Obox
Obox
Obox
Obox
Obox
Obox
Obox
No clear path to the
plugin information.
http://yoast.com/wordpress/seo/
An example of a clear path of learning.
Join the
WordPress Global
Community
thank you!
Gloria
Antonelli
@GloriaAntonelli
google +
linkedin
facebook
Emerging Technology
& Web Strategist
WordPress Developer
Consultant & Trainer
gloria@gloriaantonelli.com

Weitere ähnliche Inhalte

Was ist angesagt?

WordPress Optimisation - A4UExpo
WordPress Optimisation - A4UExpoWordPress Optimisation - A4UExpo
WordPress Optimisation - A4UExpo
Joost de Valk
 

Was ist angesagt? (9)

Thoughtful theming
Thoughtful themingThoughtful theming
Thoughtful theming
 
From WordPress Configurator to WordPress Developer
From WordPress Configurator to WordPress DeveloperFrom WordPress Configurator to WordPress Developer
From WordPress Configurator to WordPress Developer
 
Style Guide Best Practices
Style Guide Best PracticesStyle Guide Best Practices
Style Guide Best Practices
 
WRA 210 February 15, 2011
WRA 210 February 15, 2011WRA 210 February 15, 2011
WRA 210 February 15, 2011
 
Web design 3
Web design 3Web design 3
Web design 3
 
From Scratch to Launch #2 - Design phase
From Scratch to Launch #2 - Design phaseFrom Scratch to Launch #2 - Design phase
From Scratch to Launch #2 - Design phase
 
WordPress Optimisation - A4UExpo
WordPress Optimisation - A4UExpoWordPress Optimisation - A4UExpo
WordPress Optimisation - A4UExpo
 
6
66
6
 
Accessibility with Joomla [on a budget]
Accessibility with Joomla [on a budget]Accessibility with Joomla [on a budget]
Accessibility with Joomla [on a budget]
 

Ähnlich wie Create Great User Documents for Word Press

Integration of technology_into_the_curriculum
Integration of technology_into_the_curriculumIntegration of technology_into_the_curriculum
Integration of technology_into_the_curriculum
Yezenia C
 
Integration of technology_into_the_curriculum
Integration of technology_into_the_curriculumIntegration of technology_into_the_curriculum
Integration of technology_into_the_curriculum
Yezenia C
 
Digital Tools Session III
Digital Tools Session IIIDigital Tools Session III
Digital Tools Session III
mbamom
 
Direct Marketing on a Shoestring Budget 2: Content Marketing
Direct Marketing on a Shoestring Budget 2: Content MarketingDirect Marketing on a Shoestring Budget 2: Content Marketing
Direct Marketing on a Shoestring Budget 2: Content Marketing
Act-On Software
 
13 f a2 media power point2
13 f a2 media power point213 f a2 media power point2
13 f a2 media power point2
callison1318
 
Using technology to_assist_ell_s_to_acquire_en
Using technology to_assist_ell_s_to_acquire_enUsing technology to_assist_ell_s_to_acquire_en
Using technology to_assist_ell_s_to_acquire_en
carolgaudet
 
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
Techsylvania
 

Ähnlich wie Create Great User Documents for Word Press (20)

WordPress UX Workflow
WordPress UX WorkflowWordPress UX Workflow
WordPress UX Workflow
 
The power of accessibility (November, 2018)
The power of accessibility (November, 2018)The power of accessibility (November, 2018)
The power of accessibility (November, 2018)
 
NLJUG speaker academy 2023 - session 1
NLJUG speaker academy 2023 - session 1NLJUG speaker academy 2023 - session 1
NLJUG speaker academy 2023 - session 1
 
CS-AGRI Presentation and Video Editing Workshop.pdf
CS-AGRI Presentation and Video Editing Workshop.pdfCS-AGRI Presentation and Video Editing Workshop.pdf
CS-AGRI Presentation and Video Editing Workshop.pdf
 
Integration of technology_into_the_curriculum
Integration of technology_into_the_curriculumIntegration of technology_into_the_curriculum
Integration of technology_into_the_curriculum
 
Integration of technology_into_the_curriculum
Integration of technology_into_the_curriculumIntegration of technology_into_the_curriculum
Integration of technology_into_the_curriculum
 
Designing self-service support content – SD Expo Europe 2019
Designing self-service support content – SD Expo Europe 2019Designing self-service support content – SD Expo Europe 2019
Designing self-service support content – SD Expo Europe 2019
 
Producing Online Educational Videos
Producing Online Educational VideosProducing Online Educational Videos
Producing Online Educational Videos
 
Tips for Creating an Accessible & Engaging Virtual Classroom
Tips for Creating an Accessible & Engaging Virtual ClassroomTips for Creating an Accessible & Engaging Virtual Classroom
Tips for Creating an Accessible & Engaging Virtual Classroom
 
The Technical Writers Guide to Contributing to Open Source Projects
The Technical Writers Guide to Contributing to Open Source ProjectsThe Technical Writers Guide to Contributing to Open Source Projects
The Technical Writers Guide to Contributing to Open Source Projects
 
Digital Tools Session III
Digital Tools Session IIIDigital Tools Session III
Digital Tools Session III
 
How to Optimize Video Content Marketing with Google Hangouts
How to Optimize Video Content Marketing with Google HangoutsHow to Optimize Video Content Marketing with Google Hangouts
How to Optimize Video Content Marketing with Google Hangouts
 
Direct Marketing on a Shoestring Budget 2: Content Marketing
Direct Marketing on a Shoestring Budget 2: Content MarketingDirect Marketing on a Shoestring Budget 2: Content Marketing
Direct Marketing on a Shoestring Budget 2: Content Marketing
 
The Use of Social Media and Digital Skills Development in Computing
The Use of Social Media and Digital Skills Development in ComputingThe Use of Social Media and Digital Skills Development in Computing
The Use of Social Media and Digital Skills Development in Computing
 
13 f a2 media power point2
13 f a2 media power point213 f a2 media power point2
13 f a2 media power point2
 
Using technology to_assist_ell_s_to_acquire_en
Using technology to_assist_ell_s_to_acquire_enUsing technology to_assist_ell_s_to_acquire_en
Using technology to_assist_ell_s_to_acquire_en
 
A Scriptio AI Review
A Scriptio AI ReviewA Scriptio AI Review
A Scriptio AI Review
 
NLJUG speaker academy 2022 - session 1
NLJUG speaker academy 2022 - session 1NLJUG speaker academy 2022 - session 1
NLJUG speaker academy 2022 - session 1
 
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
Marie Astrid Molina (Scaleway), How to Design for a Product You Understand No...
 
Open the Door: Inviting Users to Contribute to the Online Help
Open the Door: Inviting Users to Contribute to the Online HelpOpen the Door: Inviting Users to Contribute to the Online Help
Open the Door: Inviting Users to Contribute to the Online Help
 

Kürzlich hochgeladen

Why Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire businessWhy Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire business
panagenda
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Safe Software
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
WSO2
 

Kürzlich hochgeladen (20)

Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
Connector Corner: Accelerate revenue generation using UiPath API-centric busi...Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
Connector Corner: Accelerate revenue generation using UiPath API-centric busi...
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
Why Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire businessWhy Teams call analytics are critical to your entire business
Why Teams call analytics are critical to your entire business
 
Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)Powerful Google developer tools for immediate impact! (2023-24 C)
Powerful Google developer tools for immediate impact! (2023-24 C)
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Script
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemkeProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
ProductAnonymous-April2024-WinProductDiscovery-MelissaKlemke
 
MS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectorsMS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectors
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Ransomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfRansomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdf
 
A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?A Year of the Servo Reboot: Where Are We Now?
A Year of the Servo Reboot: Where Are We Now?
 
MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
 
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin WoodPolkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
 
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu SubbuApidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
Apidays Singapore 2024 - Modernizing Securities Finance by Madhu Subbu
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
 
Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024
 
FWD Group - Insurer Innovation Award 2024
FWD Group - Insurer Innovation Award 2024FWD Group - Insurer Innovation Award 2024
FWD Group - Insurer Innovation Award 2024
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
 

Create Great User Documents for Word Press