improving wordpress themes & plugins support documentation

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Improving WordPress Themes & Plugins Support Documentation

By Gloria Antonelli

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

http://2011.chicago.wordcamp.org/2011/07/23/interview-with-gloria-antonelli/

About.me

Fine artistStarted web dev in mid 90’sCrazy about learning new technologyLearn from the bestLove to teach what I learnGo to a lot of conferencesShy online but not in personI consult, train and sometimes write.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Support documents & learning channelsare key for greatUser Experience.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

The Problem

Too many frustrated users are searching for answers on how to use your products.

examples: All in one SEO & Thematic

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Are we ready to settle down with some standards in support document creation?

It’s been the Wild West in WP development land.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

WP Gold Standard

Create standards without

stifling innovation and

creativity.

design

documentatio

n

developmentthe threed’s

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

What is your business model?

What is your development philosophy?

Full-time venture?

Business goals?Who are your target users?

Why are you making themes & plugins?

Questions to ask yourself.

Once you know tell your users!

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

The holy trinityUX IA Dev

the team : many hats, jobs & skillsCODE DESIGN UI UX IA SEO

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Are you wearing all the hats?

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

EXPECTATIONS

For users to easily find information to configure, modify & use your products.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

expe

rienc

ed u

sers

new & non tech users

The Long Tail of Users

Head

Long Tail

Unlimited niche users with various skill sets

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

expe

rienc

ed u

sers

new & non tech users

The Learning Curve

Head

Long Tail

Difficult

Easy

Unlimited niche users with various skill sets

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

expe

rienc

ed u

sers

new & non tech users

The Learning Curve

Head

Long Tail

Difficult

Easy

Unlimited niche users with various skill setslim

ited

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

[new & non tech users]

The Learning CurveDifficult

Easy

Are you addressing the needs of this market segment?

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

HTML CSS PHP JQuery* WP

WP Developer yes yes yes yes yes

Web Designer yes yes maybe maybe maybe

Flash Designer maybe maybe maybe maybe maybe

Print Designer maybe maybe no no no

Non Designer no no no no no

Target Users Skill Set**

**an estimate of skill sets *refers to all JavaScript libraries

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

“please

care

about

your end

users”Gary Vaynerchuk

FOWA Vegas 2011

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

WP Learning Curve

WordPress UI

Theme Functionality

Theme Options

Theme Widgets

Many Plugins

html

css

php

Multiple learning layers

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

WP Learning Curve

WordPress UI

Theme Functionality

Theme Options

Theme Widgets

Many Plugins

htmlcss

php

Advanced learning layers

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Users Process

Plugin Selection

Set upTheme

ModifyTheme

Theme Selection

> > >

read docssearch webview videosview tutorials

search webread reviewsselect & hopefor the best

read docssearch webview videosview tutorials

search webread reviewsread docssearch web re

pea

t as

nee

ded>

Decide to use WordPress

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Theme Support,Option Page UI,& Plugins

Don’t know what to expect until you buy in.

everyone is different

are youmaking users crazy?

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Move from Dev Centric

to User Centric

Is there a clear learning path

for all users?

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

• Collect data from users in each target segment.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

• Collect data from users in each target segment.

• Develop a prototype of learning channels.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

• Collect data from users in each target segment.

• Develop a prototype of learning channels.

• Create a foundation for the learning center.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

• Collect data from users in each target segment.

• Develop a prototype of learning channels.

• Create a foundation for the learning center.

• Write content, create videos, and tutorials.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create a [UX-Centric] Process

• Think of users needs throughout each step.

• Brainstorm ideas/solutions to ease pain points.

• Collect data from users in each target segment.

• Develop a prototype of learning channels.

• Create a foundation for the learning center.

• Write content, create videos, and tutorials.

• Conduct usability testing as you go along.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

“Don’t Make Me Think”By Steve Krug

http://www.sensible.com/

The Do-It-Yourself Guide to Finding and Fixing Usability Problems

A Common Sense Approach to Web Usability

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

User Pain Points• Don’t know where to start.

• Understanding features in different themes.

• Unfamiliar with terms & finding info.

• Different naming conventions.

• Next iterations of WP core.

• No theme support evaluation system.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!•

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

“get started” instructions – install & configure

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

Forums have a place but best to give answers before they areasked.

“get started” instructions – install & configure

guides for troubleshooting, option page, features,

modifying the theme

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

“get started” instructions – install & configure

guides for troubleshooting, option page, features,

modifying the theme

advance code & developers guide

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

“get started” instructions – install & configure

guides for troubleshooting, option page, features,

modifying the theme

advance code & developers guide

videos, tutorials and faq

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

“get started” instructions – install & configure

guides for troubleshooting, option page, features,

modifying the theme

advance code & developers guide

videos, tutorials and faq

links to external resources

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Don’t start with just a forum!• Users need more step by step:

get started instructions – install & configure

guides for troubleshooting, option page, features,

modifying the theme

advance code & developers guide

videos, tutorials and faq

links to external resources

Forums have a place but best to give answers before they areasked.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Create Multiple Channels

Guides ForumVideos Tutorials

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Documentation Tips Information Architecture

Findability

Visual Presentation

Instructional Creation

Concept Map Model

Best Practices

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

is the categorization of information into a coherent structure.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill level

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill levelClear calls of action (Start Here)

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill levelClear calls of action (Start Here)Clear navigation

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill levelClear calls of action (Start Here)Clear navigationUse descriptive headlines

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill levelClear calls of action (Start Here)Clear navigationUse descriptive headlinesUI consistency for ease of use

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Information Architecture

Arrange in order of importance Arrange in order of skill levelClear calls of action (Start Here)Clear navigationUse descriptive headlinesUI consistency for ease of useLink to external resources

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Findability

ability to locate and present usable information easily, accurately, and quickly as possible.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Findability

Create a visual map

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Findability

Create a visual mapCreate a sitemap

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Findability

Create a visual mapCreate a sitemapCreate a table of content and index

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Findability

Create a visual mapCreate a sitemapCreate a table of content and indexUse Search Engine Optimization

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Visual Presentation

Use color coding & icons

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Visual Presentation

Use color coding & icons Use white space for readability

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Visual Presentation

Use color coding & icons Use white space for readabilityUse bullet or numbered lists

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Visual Presentation

Use color coding & icons Use white space for readabilityUse bullet or numbered listsChunk instructional content

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Instructional Creation

Break down processes into clear step by step instructions.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Instructional Creation

Break down processes into clear step by step instructions.

Create new tutorials from the forum conversations.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Instructional Creation

Break down processes into clear step by step instructions.

Create new tutorials from the forum conversations.

Provide written content for videos.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Instructional Creation

Break down processes into clear step by step instructions.

Create new tutorials from the forum conversations.

Provide written content for videos.

Clarification of terminology.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Concept Map Model

Create an infographicabout your theme and theme learning channels.

http://yoast.com/wordpress-theme-anatomy/

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Standards & Best Practices

UI Consistency reduces learning curveand leverages previous experience.

Establishes UI conventions for Option pages and Plugin Documentation.

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Thank You

Gloria AntonelliEmerging Technologist StrategistConsultant & Trainer on Web 2.0Techcocktail.com writergloria@gloriaantonelli.com

socially @gloriaantonellion facebook, linkedin & twitter

7/30 – 7/31/2011 #wcchicago socially @gloriaantonelli on facebook, linkedIn & twitter

Photo credit

“Learn” Aaron Schmidthttp://www.flickr.com/photos/aaronschmidt/

“Hat man” Andrew Warrenhttp://www.flickr.com/photos/27273053@N05/4507100640/

Most others are my iPhone images from Art Museums in the US.