Embed Size (px)
DESCRIPTION
Often times technical writers end up documenting information that shouldn't be there. To improve the user experience, to enable better content management, and to stay agile, it's important we understand the pitfalls that can be highlighted by the documentation team.
Citation preview
10signs
are you bandaging product with documentation
Context!User
ExperienceContent Footprint
Agile Development
Set password
**********password
**********re-enter password
OK Cancel
Help
(somewhere in the help system…)
• Click OK to set the password. • Click Cancel to reset the fields and try
again.
Make sure the password you are setting is at least 8 characters in length and has at least one special character. If the password does not meet the criteria, an error dialog appears. Click OK to go back and try another password. Click Cancel to say Hello to stupidity!
OK
Error: Invalid password. Retry.
Cancel
Product UI
Set password
********password
********re-enter password
Set Clear
Criteria: Password must be 8 characters or more with at least one special character.
Password does not meet the criteria. Try another password
Product UI Help
(somewhere in the help system…)
UI elements and actions within the UI01
Screenshots02
More than 3 steps for navigation03
Repeated procedures04
Alternate procedures05
Troubleshooting Information06
Installation prerequisites as a chapter07
Too many cross-references08
Too many tips, notes, or warnings09
Code snippets to copy in the UI10
Bonus+
Sell the idea
be SURE
Use the product
Engage
Review for usefulness
?
