501
edits
Labs/Ubiquity/Documentation/Documentation Style Guidelines: Difference between revisions
Labs/Ubiquity/Documentation/Documentation Style Guidelines (view source)
Revision as of 02:21, 3 August 2009
, 3 August 2009→Written Text
Indolering (talk | contribs) mNo edit summary |
Indolering (talk | contribs) m (→Written Text) |
||
| Line 1: | Line 1: | ||
= | = Universal Guidelines = | ||
Minimalist documentation is a modality of documentation emphasizes three principals: | Minimalist documentation is a modality of documentation emphasizes three principals: | ||
| Line 37: | Line 37: | ||
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. | 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. | ||
== Tone == | |||
Use a conversational tone, e.i. "your email account" vs "an email account" etc. | |||
=== Rational === | |||
Known as the personalization principal, conversational tone has been proven to improve learning. [http://www.worldcat.org/oclc/228676642] | |||
= Written Text = | |||
== Error Recovery == | == Error Recovery == | ||
If there is a common error or bug in a particular release, make sure to include examples and remedies of that error. | If there is a common error or bug in a particular release, make sure to include examples and remedies of that error. | ||
One option is to include | One option is to include screen shots, tightly focused on only relevant information or using a spotlight, with prompts such as, "Can you find this on your screen?" | ||
== Guided Discovery == | == Guided Discovery == | ||