<?xml version="1.0" encoding="UTF-8"?> <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" ><channel><title>Indolering.com &#187; summer09</title> <atom:link href="http://indolering.com/category/ubiquity/summer09/feed/" rel="self" type="application/rss+xml" /><link>http://indolering.com</link> <description>Personal &#38; Professional Blog</description> <lastBuildDate>Thu, 15 Jul 2010 04:08:43 +0000</lastBuildDate> <language>en</language> <sy:updatePeriod>hourly</sy:updatePeriod> <sy:updateFrequency>1</sy:updateFrequency> <generator>http://wordpress.org/?v=abc</generator> <item><title>Marketing UI Research Paper: Some Love From ToCHI</title><link>http://indolering.com/ubiquity/marketing-ui-tochi/</link> <comments>http://indolering.com/ubiquity/marketing-ui-tochi/#comments</comments> <pubDate>Wed, 19 May 2010 21:30:41 +0000</pubDate> <dc:creator>Zachary Lym</dc:creator> <category><![CDATA[Ubiquity]]></category> <category><![CDATA[summer09]]></category><guid isPermaLink="false">http://indolering.com/?p=549</guid> <description><![CDATA[One vote for, one  vote in the middle, and one vote against publication.  Essentially, they wanted more formal psych study about video and learning which requires a different kind of statistical validity than what usability provides.  My error was writing this like a psych study (which I have written before) and not like a usability [...]]]></description> <content:encoded><![CDATA[<p>One vote for, one  vote in the middle, and one vote against publication.  Essentially, they wanted more formal psych study about video and learning which requires a different kind of statistical validity than what usability provides.  My error was writing this like a psych study (which I have written before) and not like a usability study. My one solid &#8220;yes&#8221; vote, the editorial encouragement, and my usability mentors all tell me the paper is worthy of publication -just in a more <em>usability</em> oriented journal.</p><p><span id="more-549"></span></p><p>It&#8217;s pretty clear that author&#8217;s based their judgment on usability  testing standards and their external validity,</p><blockquote><p>&#8220;It does not help to compensate for a sloppy experimental  design and by  calling it a “qualitative study.&#8221;</p></blockquote><p>Ouch, that&#8217;s a zinger!  But I can go one further: the test<em> didn&#8217;t  have an experimental design</em>- at least by the standards I was taught  in my psych research class.  No, I did an industry standard iterative usability study which does, ahem, provide <a href="http://www.useit.com/alertbox/20000319.html">statistically</a> valid results (I had nearly 15 test subjects in the study, btw).</p><p>We get to see what is going on inside their heads, not just A/B comparisons like psych studies rely on.  If I wanted to do a psych study I would have just tested people with  using Apple&#8217;s iPhone commercial-Apple probably did similar iterative  studies like the one I did.  Indeed, if I they had published any of their data I would have considered an A/B study aimed to get statistical significance with controls and the like.</p><p>My one vote for acceptance  talked only about the subject and wanted more treatment of side  issues and other usability oriented discussions, accepting the iterative test design for what it is.  S/he also wrote &#8220;It is also well written and easy to read&#8221; giving me a 4/5 marks on the readability, the in between vote gave me a 3/5, and the hard no gave me a 2/5&#8230;</p><p>I do admit, now that I am a year or so further along in my cognitive psych studies my preliminary thinking on human perception and learning <em>was</em> fundamentally broken.  It followed a simplified cognitive psych model that usability practitioners use.  I often cringe during usability discussions and the (mis)interpretation of the users upper level behavior (thinking, decision-making, understanding) and how it&#8217;s linked to lower level processes (perception, attention, and recognition).  It&#8217;s also what bothers me about Malcom Gladwell&#8217;s work, which is a pretty unpopular position : /</p><p>Part of it is bloat- even my recent<em> Review of Cognitive Psychology</em> class didn&#8217;t discuss some established science I have been reading about on the side because it took 10 years for that research to <em>become</em> established.  My professor knew about the research, but the book and class structure hadn&#8217;t been updated.</p><p>However, I think the fundamental issue is  that usability is an engineering discipline and we abstract the lower level processes away because we don&#8217;t need that extra information to know that a user doesn&#8217;t get what s/he is being asked to do.  For example, most UI modeling assumes we can&#8217;t think about two things at once.  But we do.  It also assumes we can&#8217;t take in more than stream of information at a time.  But we do, at <em>some</em> level we &#8220;resolve&#8221; &#8220;all&#8221; information otherwise the &#8220;cocktail effect&#8221; (when you pick out your name at a chatty party) wouldn&#8217;t exist.  But even that metaphor isn&#8217;t an exact fit to the actual physical processes that are going on.</p><p>As they pointed out, &#8220;The study is organized and presented more  as a pilot study,  which is a perfectly legitimate step to take in a  research program, but  it is just a beginning. My recommendation is in  agreement with the  reviewers, that you should consider continuing the  work but &#8230; as a more  full-fledged research project.&#8221;  Now that Ubiquity is hibernating and I don&#8217;t care about marketing research there isn&#8217;t much reason to do a larger study.</p><p>In the end, I just want the  paper in some research database so people know what to expect and how  to do it.  I plan to do some lite editing (as this post probably needs) and  I will resubmit to a journal more on the usability side of life.</p> ]]></content:encoded> <wfw:commentRss>http://indolering.com/ubiquity/marketing-ui-tochi/feed/</wfw:commentRss> <slash:comments>0</slash:comments> </item> <item><title>Got my paper back from the editor</title><link>http://indolering.com/personal/paper-edito/</link> <comments>http://indolering.com/personal/paper-edito/#comments</comments> <pubDate>Sun, 22 Nov 2009 20:49:11 +0000</pubDate> <dc:creator>Zachary Lym</dc:creator> <category><![CDATA[Personal]]></category> <category><![CDATA[Ubiquity]]></category> <category><![CDATA[summer09]]></category><guid isPermaLink="false">http://www.indolering.com/?p=298</guid> <description><![CDATA[Every page looks like this.  That&#8217;s what paying for editorial help gets you: real advice.]]></description> <content:encoded><![CDATA[<p><a href="http://blog.indolering.com.s95429.gridserver.com/wp-content/uploads/2009/11/Picture-53.png"><img class="aligncenter size-medium wp-image-299" title="Marketing UI Editorial Screenshot" src="http://www.indolering.com/wordpress/wp-content/uploads/Picture-53-434x313.png" alt="Marketing UI Editorial Screenshot" width="434" height="313" /></a></p><p>Every page looks like this.  That&#8217;s what paying for editorial help gets you: real advice.</p> ]]></content:encoded> <wfw:commentRss>http://indolering.com/personal/paper-edito/feed/</wfw:commentRss> <slash:comments>1</slash:comments> </item> <item><title>Sessions 6, 7, 8, &amp; 9</title><link>http://indolering.com/ubiquity/sessions6789/</link> <comments>http://indolering.com/ubiquity/sessions6789/#comments</comments> <pubDate>Sun, 11 Oct 2009 22:26:51 +0000</pubDate> <dc:creator>Zachary Lym</dc:creator> <category><![CDATA[Ubiquity]]></category> <category><![CDATA[summer09]]></category> <category><![CDATA[featured]]></category> <category><![CDATA[syntax highlighting]]></category> <category><![CDATA[Usability]]></category> <category><![CDATA[usability testing]]></category><guid isPermaLink="false">http://www.indolering.com/?p=214</guid> <description><![CDATA[Despite my best efforts on the documentation front, users still failed to grasp the simplistic syntax scheme of Ubiquity. I suspected this was due to poor contextual &#8220;documentation.&#8221;  So I designed an experiment testing out a simpler skin. Below is an expert user, a former networking technician for Microsoft and an admin for their XBox [...]]]></description> <content:encoded><![CDATA[<p style="text-align: left;">Despite my best efforts on the documentation front, users still failed to grasp the simplistic syntax scheme of Ubiquity. I suspected this was due to poor contextual &#8220;documentation.&#8221;  So I designed an experiment testing out a simpler skin.</p><p style="text-align: left;"><span id="more-214"></span></p><p style="text-align: left;">Below is an expert user, a former networking technician for Microsoft and an admin for their XBox Live division whom is familiar with command lines.  He totally missed the command premise, he mistook Ubiquity for the search box, also note how the user doesn&#8217;t read the <em>suggestion text</em>.</p><p style="text-align: center;"><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="273" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6658663&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="273" src="http://vimeo.com/moogaloop.swf?clip_id=6658663&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><p style="text-align: left;">While trying to customize a skin I accidentally got Ubiquity without <em>any</em> styling&#8230; and found it very refreshing.</p><p style="text-align: left;"><a href="http://indolering.com/wp-content/uploads/2009/09/Picture-8.png"><img class="aligncenter size-medium wp-image-216" title="Blank Ubiquity Screenshot" src="http://indolering.com/wp-content/uploads/2009/09/Picture-8-300x118.png" alt="" width="300" height="118" /></a></p><p style="text-align: left;">I also used Enso on my media server and took note of the lite nature of text decorations, syntax highlighting in the text entry field, as well as the auto-completion.</p><div class="mceTemp mceIEcenter" style="text-align: center;"><dl class="wp-caption aligncenter" style="width: 413px;"><dt class="wp-caption-dt"><img class="   " title="Enso" src="http://humanized.com/enso/launcher/gfx/screen4.jpg" alt="From the Humanized website" width="403" height="242" /></dt><dd class="wp-caption-dd">From the Humanized website</dd></dl></div><p style="text-align: left;">For test 7 I switched the skin to a <a href="http://gist.github.com/189622">modified Simpliquity skin </a>with much larger font and a white background.  I also attempted to hack syntax highlighting.  However, I was unable to get delimiter highlighting working in the <span style="color: #999999;"><em>suggested arguments</em></span> area in time for the tests.  Never-the-less, it seems to have helped.</p><p style="text-align: center;"><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="273" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6676976&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="273" src="http://vimeo.com/moogaloop.swf?clip_id=6676976&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><p style="text-align: left;">The user picked up the command structure immediately.  The user still thinks the optional augments are not optional -a mistake several past participants made as well.  The most minimalist way to solve this is by having a vanilla command and command with optional arguments in the suggestion list, with a fuller explanation in the help text.</p><blockquote><p style="text-align: left;"><span style="color: #ff6600;">email</span><em> this page<br /> </em></p><p style="text-align: left;"><span style="color: #ff6600;">email</span> <em>message</em> <em><span style="color: #ff6600;">to</span> name or email address</em></p></blockquote><p style="text-align: left;">User #8 threw a wrench into my theory that syntax highlighting would convey the command and argument structure.  Although he did <em>functionally</em> score better than user 6 it was clear that <em>I</em> prompted him to search for weather <span style="text-decoration: underline;">in</span> NYC.  Although, if you watch closely, he first types &#8220;ne&#8221; instead of nyc, mimicking the autosuggets.  Additionally, he also nails the modifier in &#8220;email <strong>to</strong>&#8221; after watching the video a second time through.</p><p style="text-align: center;"><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="273" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6768840&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="273" src="http://vimeo.com/moogaloop.swf?clip_id=6768840&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><p style="text-align: left;">The confusion from #8 was enough that I tested another person.  Here is a Linux admin, getting it right out of the gate.  Big thanks to satyr for getting delimiter highlighting working!  (It&#8217;s in the nightlies, or as an xpi here.)</p><p style="text-align: center;"><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="273" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6981498&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="273" src="http://vimeo.com/moogaloop.swf?clip_id=6981498&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><p style="text-align: left;">Users 7 &amp; 9 are Linux users, while 6 &amp; 8 are Windows admins.  Despite all being familiar with command lines, obviously the Linux admins will have a better pre-existing mental model.  Will see if future tests show continue to show an improvement.</p><p style="text-align: left;">Give feedback people!  Even mean feedback!  Especially mean feedback!</p><h3 style="text-align: left;">Update, Oct 24th</h3><p style="text-align: left;">Just noticed that the compressor didn&#8217;t provide sound, grrrrr!  Will investigate&#8230;</p><p style="text-align: left;"><p style="text-align: left;"> ]]></content:encoded> <wfw:commentRss>http://indolering.com/ubiquity/sessions6789/feed/</wfw:commentRss> <slash:comments>0</slash:comments> </item> <item><title>Sessions 4 &amp; 5</title><link>http://indolering.com/ubiquity/summer09-4-5/</link> <comments>http://indolering.com/ubiquity/summer09-4-5/#comments</comments> <pubDate>Sat, 05 Sep 2009 20:08:01 +0000</pubDate> <dc:creator>Zachary Lym</dc:creator> <category><![CDATA[Ubiquity]]></category> <category><![CDATA[summer09]]></category> <category><![CDATA[featured]]></category> <category><![CDATA[Usability]]></category><guid isPermaLink="false">http://www.indolering.com/?p=202</guid> <description><![CDATA[Couple more sessions using the new translate commercial.  In short:• Users are unable to tell the difference between the two video clips, so slight differences are a no no. • Users still see Ubiquity as command specific as apposed to a generalized command framework.]]></description> <content:encoded><![CDATA[<p>Couple more sessions using the new translate commercial.</p><p><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="251" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6242699&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="251" src="http://vimeo.com/moogaloop.swf?clip_id=6242699&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><ol><li>Users are unable to tell the difference between the two video clips, so slight differences are a no no.  Repetition may be key as users just don&#8217;t have time to digest what happened the first time around and are unable to spot differences between the two clips.</li><li>Users still see Ubiquity as command specific as opposed to a generalized command framework.  This is despite the generalized example command.</li></ol><p>Will try two separate, unrelated commands next time.  The lack of users ability to generalize from the suggestions (despite attempts to do so) is also evidence for code highlighting.  Videos after the jump.</p><p>*Update* Here is the latest incarnation, now with real <a href="http://www.mozilla.com/en-US/about/logo/style.html">FF Meta</a>!</p><p><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="240" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6451689&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="240" src="http://vimeo.com/moogaloop.swf?clip_id=6451689&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object><br /> <span id="more-202"></span></p><p>You need a password for these, <a href="emailto:zachlym@indolering.com">email me</a>.</p><p><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="240" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6439051&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="240" src="http://vimeo.com/moogaloop.swf?clip_id=6439051&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p><p><object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="436" height="240" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0"><param name="allowfullscreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="src" value="http://vimeo.com/moogaloop.swf?clip_id=6438901&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" /><embed type="application/x-shockwave-flash" width="436" height="240" src="http://vimeo.com/moogaloop.swf?clip_id=6438901&amp;server=vimeo.com&amp;show_title=1&amp;show_byline=0&amp;show_portrait=0&amp;color=ff9933&amp;fullscreen=1" allowscriptaccess="always" allowfullscreen="true"></embed></object></p> ]]></content:encoded> <wfw:commentRss>http://indolering.com/ubiquity/summer09-4-5/feed/</wfw:commentRss> <slash:comments>2</slash:comments> </item> <item><title>Learning Ubiq P1: Minimalist Documentation</title><link>http://indolering.com/ubiquity/learning-ubiq-p1-documentation/</link> <comments>http://indolering.com/ubiquity/learning-ubiq-p1-documentation/#comments</comments> <pubDate>Mon, 13 Jul 2009 21:22:39 +0000</pubDate> <dc:creator>Zachary Lym</dc:creator> <category><![CDATA[Ubiquity]]></category> <category><![CDATA[summer09]]></category> <category><![CDATA[documentation]]></category> <category><![CDATA[featured]]></category> <category><![CDATA[Usability]]></category> <category><![CDATA[usability testing]]></category><guid isPermaLink="false">http://www.indolering.com/?p=361</guid> <description><![CDATA[Today I am going to talk about a typical users, how they learn, and the principals of minimalist documentation.  If you want to skip the fluff, head to the <a title="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines" href="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines">minimalist style guidelines</a> for Ubiquity's documentation.]]></description> <content:encoded><![CDATA[<div><a href="http://indolering.com/wp-content/uploads/2009/07/Wikipedia_Screenshot-Typed.png"><br /> </a>It has been over a month since my last post -testing has taken a backseat to reading research in social learning theory and technical communications.  But now I have some more solid ideas I want to share in this 3-part series.</div><div><div><div><p>Today I am going to talk about a typical users, how they learn, and the principals of minimalist documentation.  If you want to skip the fluff, head to the <a title="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines" href="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines">minimalist style guidelines</a> for Ubiquity&#8217;s documentation.</p><h2>Reasoning</h2><p><em>(skip this if your not a psych geek ; )</em></p><p>Albert Bandura defined three cognitive prerequisites to learning:</p><ol><li>Motivation</li><li>Attention</li><li>Retention</li></ol><p>Tutorials and other traditional documentation which strive to give conceptual overviews are the best way to learn. Volumes of psychological research prove that the thorough processing prompted by a conceptual overview improves retention and performance.</p><p>However, the typical setting for traditional psychological tests of learning guarantee both motivation and attention -such as work training. Web browsers are a glass pane- their purpose is to deliver content, their utility invisible, their new features just smudges on the glass, obscuring the view.</p><p>Watching professors at school is a lesson on how people interact with FireFox and obstructions to their goals. If FireFox doesn’t start immediately they become flustered and switch to IE. If FireFox asks to apply an update s/he quickly clicking “cancel” to whatever pops up. They are trying to teach a class, not learn new skills or perform maintenance!</p><p>Even in my usability studies, when participants actually have the goal of learning the interface, they are seemingly incapable of reading the documentation. Only one user, who was very insecure about his technological prowess, methodically read the tutorial.  After that, his performance was great. However, that means that the tutorial only works for 10% of a dedicated user-base, while 90% are left in the dark.</p><p>The test was a bit skewed; users were artificially motivated, but they also had the discoverability problem which Taskfox will fix, but many still had either poor performance or didn’t value the functionality that Ubiquity added.</p><p>So what do we do about this? The most important area is the auto-suggest, it must be magical. I have some ideas on how to add to that, but first some lower-level stuff must be fixed.  The most boring, but essential topic, is how we configure our documentation.</p><h2>About Minimalist Documentation</h2><p>The minimalist documentation style, as outlined by Carroll in The Minimal Manual, shows massive improvements in real-world tests where motivation is not guaranteed.  It has subsequently become the dominant paradigm in the technical communication field.  The overall guiding principals of this movement are:</p><ol><li>Procedural Instruction</li><li>Minimal Wording</li><li>Error Recovery</li><li>Guided Discovery</li></ol><h3>Procedural Instruction</h3><p>By focusing on procedural, task based instruction, minimalist documentation caters to how users naturally browse documentation and think about their problems.</p><p>Users interaction with documentation occurs when they are inhibited in performing a task.  When users to kill the paper clip, they do not take a tutorial on how to use word or read from the beginning of the manual- they skip to the “paper clip” chapter hoping to find something about turning it off.</p><p>Thus minimalist documentation is focused on examples of tasks, there is no attempt to teach the underlying models of operation.  Real users are trying to do something, not understand the grand scheme of things.</p><p>Secondly, minimalist documentation is as non-sequential as possible. Each example is independent of the previous example, requiring no knowledge that the user likely skipping anyway.</p><h3>Minimal Wording</h3><p>Minimalist documentation attempts to cut down the thicket of prose obstructing the users view of a potential solution.  Users are skimming, facilitate that by leaving only the most essential wording, writing <a title="http://en.wikipedia.org/wiki/Inverted_pyramid" href="http://en.wikipedia.org/wiki/Inverted_pyramid">inverted pyramid style</a>, breaking rules of grammar if it increases clarity, and bolding key verbs is used to help users pick out important information.</p><h3>Error Recovery</h3><p>Attempt to provide clear checkpoints and examples so a user can make sure that they have carried out the example correctly. Screenshots should crop non-relevant information (unless it visually orients the user) and emphasize important areas.</p><p style="text-align: center;"><img class="aligncenter size-full wp-image-43" title="Wikipedia_Screenshot-Typed" src="http://indolering.com/wp-content/uploads/2009/07/Wikipedia_Screenshot-Typed.png" alt="" width="420" height="185" /></p><div><div><div><p>If something is particularly tricky or can cause harm, warn users and give options of undoing the damage or reseting the environment.</p></div></div></div><h3>Guided Discovery</h3><p>Ubiquity guides users to the functions that they want, and keeps the unnecessary ones hidden from view via it’s auto-suggest.  I will offer some suggestions on how to improve auto-suggest in a more automated way in Part 3.</p><p>Read (the much better, imho) <a href="http://www.indolering.com/ubiquity/learning-ubiq-p2/">Part 2</a></p><p>Go to the Ubiquity <a title="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines" href="https://wiki.mozilla.org/Labs/Ubiquity/Documentation/Documentation_Style_Guidelines">Minimalist Documentation guidelines</a></p></div></div></div> ]]></content:encoded> <wfw:commentRss>http://indolering.com/ubiquity/learning-ubiq-p1-documentation/feed/</wfw:commentRss> <slash:comments>1</slash:comments> </item> </channel> </rss>
<!-- Performance optimized by W3 Total Cache. Learn more: http://www.w3-edge.com/wordpress-plugins/

Minified using disk
Page Caching using disk (enhanced) (user agent is rejected)

Served from: indolering.com @ 2010-09-10 10:38:56 -->