501
edits
Labs/Ubiquity/Documentation/Documentation Style Guidelines: Difference between revisions
Jump to navigation
Jump to search
m
Labs/Ubiquity/Documentation/Documentation Style Guidelines (view source)
Revision as of 01:48, 3 August 2009
, 3 August 2009no edit summary
Indolering (talk | contribs) |
Indolering (talk | contribs) mNo edit summary |
||
| Line 3: | Line 3: | ||
== Procedural Instruction == | == Procedural Instruction == | ||
Focus on examples of real tasks and activities not conceptual overviews. | |||
Make each example a self contained unit independent of any other example. | |||
Examples should be broken down into the command level with stand-alone examples of each command. | |||
# Tap option + space bar | |||
# Type: wikipedia firefox | |||
# You should see this exact screen: [[Image:]] | |||
# Tap the Enter key to open the Wikipedia article in a new tab | |||
== Minimal Wording == | == Minimal Wording == | ||
Facilitate a users search for information by removing obstacles blocking their path- excess verbiage. '''Be ruthless'''. | |||
In a larger perspective simplify all help UI's (users were confused by the Wiki additions) and dump users directly to help oriented Q/A systems such as Get Satisfaction and Chat rooms at the end of wiki posts. | |||
=== Reasoning === | |||
Minimal wording extends beyond short sentences, intros, exits, and philosophical reasoning's are for blog-posts, not for intros. Users just do not read them, | |||
"<nowiki>[Users]</nowiki> encounter a usability problem on average about '''once every 75 minutes''' and typically spend about '''a minute''' looking for a solution" Be ruthless. [http://www.google.com/search?hl=en&client=firefox-a&rls=org.mozilla%3Aen-US%3Aofficial&hs=gb7&q=Toward+a+More+Accurate+View+of+When+and+How.+People+Seek+Help+with+Computer+Applications+filetype%3Apdf&aq=f&oq=&aqi=] | |||
Furthermore, "Users will search once, maybe twice."[http://www.uie.com/articles/users_search_once/] If their first attempt isn't successful it's best to dump them to a moderated assistance queue then let the problem fester. | |||
== Error Recovery == | == Error Recovery == | ||
| Line 20: | Line 37: | ||
== Procedural Instruction == | == Procedural Instruction == | ||
Slash the tutorial, get rid of video overviews, etc, and | Slash the tutorial, get rid of video overviews, etc, and | ||
== Minimal Wording == | == Minimal Wording == | ||
== Error Recovery == | == Error Recovery == | ||