2. Who the hell are you?
Siobhan McKeown
Words for WP
WordPress Documentation
Specialist
Find my writing on:
Smashing Magazine
WPMU.org
The Quietus
Tuesday, 27 March 12
5. • As an aid to future developers working on you product
• So developers can do what they need to
• Demonstrate pride in your code
• Teach end-users about your product
• Save on support forum request
Tuesday, 27 March 12
20. Stick to the point
Don’t start talking about
something off-topic
Keep the message of your
tutorial or guide clear
Make sure your reader
comes away with the
message you need them to
Tuesday, 27 March 12
21. Learning Curve
• Produce docs for people at all levels
• Use taxonomies to categorise your docs properly
• Use navigation to properly guide users through
your docs
Tuesday, 27 March 12
22. Update
• Documentation needs to be updated with your product
• Don’t assume that once it’s done it’s done - it’s never
done!
• Use Content Audit or Edit Flow for keeping track of
documents
Tuesday, 27 March 12
23. Style
write in second person - i.e.
“you need to create a page”
it’s not poetry - it’s documentation
only say what you have to
Tuesday, 27 March 12
24. Formatting
• use bold and italics
• have call-outs for tips and info
• use ordered and unordered lists
• use headings
• save time by writing in HTML
Tuesday, 27 March 12
26. Screenshots & Video
• When writing a tutorial screenshot everything
• Screenshots help visual learners follow your tutorial
• Use screencasts to help visual and auditory learners
Tuesday, 27 March 12
27. Proofread!
• offer your wife/girlfriend/husband/partner/boyfriend/brother/sister/
girlfriend/best-friend/aunt/uncle/cousin/next-door-neighbour/mother-in-law/
business partner/secretary/postman/doctor/landlord cake to proofread for
you
• a fresh pair of eyes will see things that you will miss
Tuesday, 27 March 12
28. • Content Audit
• Front-end editor
• Edit Flow
• After the Deadline
• Document Revisions
Tuesday, 27 March 12
29. Content Audit http://wordpress.org/extend/plugins/content-audit/
Tuesday, 27 March 12
30. Front-end Editor http://wordpress.org/extend/plugins/front-end-editor/
Tuesday, 27 March 12
