{"id":410,"date":"2007-05-05T10:48:40","date_gmt":"2007-05-05T10:48:40","guid":{"rendered":"http:\/\/scientopia.org\/blogs\/goodmath\/2007\/05\/05\/bad-software-design-getting-the-level-wrong\/"},"modified":"2007-05-05T10:48:40","modified_gmt":"2007-05-05T10:48:40","slug":"bad-software-design-getting-the-level-wrong","status":"publish","type":"post","link":"http:\/\/www.goodmath.org\/blog\/2007\/05\/05\/bad-software-design-getting-the-level-wrong\/","title":{"rendered":"Bad Software Design: Getting the Level Wrong"},"content":{"rendered":"<p> I came across <a href=\"http:\/\/itre.cis.upenn.edu\/~myl\/languagelog\/archives\/004466.html\">a link to an excellent article<\/a> that provides an example of one of my professional bugaboos: the truly awful way that we often design software in terms of how the implementer thinks of it, instead of how the user will think of it.<\/p>\n<p><!--more--><\/p>\n<p> Take a look at that link to see what I mean. The short version of it is: xerox produces a copy machine that includes a billing system. Attached to the copier is a little card reader.  You can&#8217;t use the machine without inserting a card into the reader telling it who should pay for the paper\/toner you use. The card reader&#8217;s software is implemented as if it&#8217;s a <em>separate machine<\/em>. It provides prompts in terms of <em>its<\/em> state as an independent machine. So when you walk up to the copier, the card reader display says &#8220;READY&#8221;.  The fact that it says &#8220;READY&#8221; means that the <em>card reader<\/em> is ready to read a card. But <em>the copy machine<\/em> is not ready. In fact,t he copy machine isn&#8217;t ready to copy until the card reader display <em>doesn&#8217;t<\/em> say ready. In fact, the glowing &#8220;READY&#8221; sign attached to the copier means that the copy machine is <b>not<\/b> ready.<\/p>\n<p> To the user of the copy machine, it&#8217;s <em>one machine<\/em>. The user walks up to it, and does whatever they need to do to make their copies. They don&#8217;t think of it as &#8220;A copier and a card reader that communicate with one another&#8221;. They think of it as &#8220;A copier with a card reader for billing&#8221;. <\/p>\n<p> But the designers of the machine didn&#8217;t think of it that way. To the guys implementing the card reader, the reader was a <em>separate machine<\/em>, and they designed its displays and user interactions around the idea that it&#8217;s a separate machine. So the reader says &#8220;READY&#8221; when it&#8217;s ready to do its job &#8211; never mind that it&#8217;s job isn&#8217;t a separate task in the mind of the <em>user<\/em>.<\/p>\n<p> This kind of thing happens <em>constantly<\/em> in software. In my own area of specialiation &#8211; software configuration management &#8211; virtually every tool on the market presents itself to users in terms of the horribly ugly and complicated concepts of how the SCM system is implemented. Looking at popular SCM systems, you&#8217;ll constantly see tons of things: branches, merges, VOBS, WOBS, splices,<br \/>\ngaps, configurations, version-pattern-expressions. To use the systems as they&#8217;re presented to you, you need to learn whatever subset of those concepts your system uses. But those concepts are all completely irrelevant to you, as a user of the system. What you&#8217;re trying to do is to use a tool that preserves the history of how your system was developed, and that lets you share changes with your coworkers in a manageable way. What does a VOB or a VPE have to do with that?<\/p>\n<p> I&#8217;m not trying to claim that I&#8217;m perfect. I spent the majority of the my time working in SCM building a system with <em>exactly<\/em> those flaws. I&#8217;m as guilty as anyone else. And I didn&#8217;t realize the error of doing things that way by myself. I had to have it pointed out to me by someone who&#8217;s a lot smarter than I am. But once he made me aware of it, it  made me aware of this as a ubiquitous problem. It doesn&#8217;t just happen in things like embedded systems (the Xerox card reader) and SCM systems. It&#8217;s in word processors and spreadsheets, file browsers, web browsers, desktop shells, cell phones, music players&#8230;<\/p>\n<p> Software developers &#8211; like me &#8211; need to learn that <em>users<\/em> don&#8217;t view systems the same way that <em>developers<\/em> do, and the right way to build a system is by focusing on the view of the <em>user<\/em>. That copy machine should <em>not<\/em> say ready until it&#8217;s ready to copy: the user doesn&#8217;t give a damn that the <em>card reader<\/em>is ready. My SCM system should allow  me to say &#8220;I want share my changes with the guy at the desk next to me&#8221;, not &#8220;Create a new branch derived from the latest integration baseline containing the set of changes in my workspace  and then tell me the name of that new branch so that I can email it to my neighbor&#8221;: as a user of an SCM system, I don&#8217;t <em>care<\/em> that you needed to create a new branch. I don&#8217;t want to know what the root of that new branch is. I don&#8217;t want to know about the internal identifiers of branches. What I want to do is share my changes with my coworker &#8211; and the system was built <em>to let me do that<\/em>. Why is it designed to make that so unnatural and confusing? Because the developer was focused on &#8220;How do I implement the capability to do that?&#8221;, and then presented it to the users in terms of how they built it, not in terms of how the user was going to make use of it.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>I came across a link to an excellent article that provides an example of one of my professional bugaboos: the truly awful way that we often design software in terms of how the implementer thinks of it, instead of how the user will think of it.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[7],"tags":[],"class_list":["post-410","post","type-post","status-publish","format-standard","hentry","category-bad-software"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p4lzZS-6C","jetpack_sharing_enabled":true,"jetpack_likes_enabled":true,"_links":{"self":[{"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/posts\/410","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/comments?post=410"}],"version-history":[{"count":0,"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/posts\/410\/revisions"}],"wp:attachment":[{"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/media?parent=410"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/categories?post=410"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.goodmath.org\/blog\/wp-json\/wp\/v2\/tags?post=410"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}