{"id":285,"date":"2007-11-05T18:50:43","date_gmt":"2007-11-05T22:50:43","guid":{"rendered":"http:\/\/michaelnielsen.org\/blog\/?p=285"},"modified":"2007-11-05T18:54:12","modified_gmt":"2007-11-05T22:54:12","slug":"refactoring-prose","status":"publish","type":"post","link":"https:\/\/michaelnielsen.org\/blog\/refactoring-prose\/","title":{"rendered":"Refactoring Prose"},"content":{"rendered":"<p>One of the most interesting ideas from software development is that of <a href=\"http:\/\/en.wikipedia.org\/wiki\/Refactoring\">refactoring code<\/a>.<\/p>\n<p>A <a href=\"http:\/\/www.amazon.com\/exec\/obidos\/ASIN\/0201485672\">famous book<\/a> on refactoring identifies a set of &#8220;code smells&#8221; that indicate when something is wrong with your code (<a href=\"http:\/\/martinfowler.com\/bliki\/\">blog<\/a>).  The book is in part diagnostic, explaining how to identify poor code and determine what the problem is.  It is also prescriptive, explaining how to fix many common problems.<\/p>\n<p>I like the idea of producing a similar list of &#8220;writing smells&#8221; that helps writers identify bad prose, figure out what the problem is, and how to improve it.  Such a list would be much more useful than the laundry lists of do&#8217;s and don&#8217;ts that form the bulk of style manuals such as Strunk and White.  Such laundry lists are usually focused on the problem of writing clearly, a problem for which it is possible to give relatively precise rules, not the vaguer problem of writing in a way that is <em>interesting<\/em>.  For the latter problem, the concept writing smells and refactoring prose is, I think, just what is needed.<\/p>\n<p>An example of such a list of writing smells is provided by the book <a href=\"http:\/\/www.amazon.com\/Made-Stick-Ideas-Survive-Others\/dp\/1400064287\/ref=pd_bbs_sr_1\/002-0904535-8607235?ie=UTF8&amp;s=books&amp;qid=1194300943&amp;sr=1-1\">&#8220;Made to Stick&#8221;<\/a> by <a href=\"http:\/\/www.madetostick.com\/blog\/\">Chip and Dan Heath<\/a>.  Summarizing the book here doesn&#8217;t do it justice, but it does suggest the following list of prose smells:<\/p>\n<ul>\n<li>Is the prose unnecessarily complex?<\/li>\n<li>Is the prose surprising?  If not, why bore your reader?<\/li>\n<li>Are abstract points illustrated by concrete examples and stories?<\/li>\n<li>Is the prose credible enough?  Where are the most significant credibility gaps?<\/li>\n<li>Does the prose engage the reader&#8217;s emotions at all?<\/li>\n<li>Does the prose engage issues the reader considers important?<\/li>\n<\/ul>\n<p>These are all &#8220;just&#8221; common sense, of course, but I definitely find that when I take the time to apply the Heath&#8217;s list my writing improves considerably.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>One of the most interesting ideas from software development is that of refactoring code. A famous book on refactoring identifies a set of &#8220;code smells&#8221; that indicate when something is wrong with your code (blog). The book is in part diagnostic, explaining how to identify poor code and determine what the problem is. It is&hellip; <a class=\"more-link\" href=\"https:\/\/michaelnielsen.org\/blog\/refactoring-prose\/\">Continue reading <span class=\"screen-reader-text\">Refactoring Prose<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[],"tags":[],"class_list":["post-285","post","type-post","status-publish","format-standard","hentry","entry"],"_links":{"self":[{"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/posts\/285","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/comments?post=285"}],"version-history":[{"count":0,"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/posts\/285\/revisions"}],"wp:attachment":[{"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/media?parent=285"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/categories?post=285"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/michaelnielsen.org\/blog\/wp-json\/wp\/v2\/tags?post=285"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}