{"id":64,"date":"2004-07-28T09:13:00","date_gmt":"2004-07-28T09:13:00","guid":{"rendered":"http:\/\/sumankumar.com\/blog\/?p=64"},"modified":"2004-07-28T09:13:00","modified_gmt":"2004-07-28T09:13:00","slug":"style-guides-sacrosanct","status":"publish","type":"post","link":"https:\/\/sumankumar.com\/blog\/2004\/07\/style-guides-sacrosanct\/","title":{"rendered":"Style guides: Sacrosanct?"},"content":{"rendered":"<p>How many times have you paused and reflected, \u2018man, I know I am right, but the style guide does not agree\u2026\u2019? <\/p>\n<p>For example, some style guides proscribe the use of the possessive <strike>pronoun<\/strike> noun (earlier I had written &#8216;pronoun&#8217;. Thanks Guy for pointing it out.) and demand that you elaborate: <b>IP address of the Server <\/b> as against <b> Server\u2019s IP address <\/b>.  In certain contexts I prefer the latter; for it is shorter and I am sure it won\u2019t confuse the users.  But the style guide does not agree. <\/p>\n<p>I think that a style guide is by no means sacrosanct. It is around to help us, and not to put us in dilemmas. So, if you strongly believe that certain rules of the guide are rigid do share your opinion. A style guide evolves. It needs inputs from all concerned for it to become comprehensive, robust, and current. Do we need styled guides at all? Yes sir, product documentation needs to be consistent in terms of tone, style, and grammar. So, we need style guides. Also, when there is a team of writers working on the various modules of the product, a style guide helps in making the documentation coherent and consistent.<br \/>\n<br \/>You thoughts?<br \/>\n<br \/><strong>Some style guides&#8230;<\/strong><br \/>\n<br \/><a href=\"http:\/\/www.apastyle.org\/\">The American Psychological Association (APA) Style<\/a><\/p>\n<p><a href=\"http:\/\/www.columbia.edu\/cu\/cup\/cgos\/idx_basic.html\">Columbia guide to online writing<\/a><\/p>\n<p><a href=\"http:\/\/andromeda.rutgers.edu\/~jlynch\/Writing\/\">Lynch Guide<\/a><\/p>\n<p>Write to me: Suman[at]techwritersindia[dot]com<\/p>\n<div class=\"blogger-post-footer\">\n<map name=\"google_ad_map_061219083749040728091300\">\n<area shape=\"rect\" href=\"http:\/\/imageads.googleadservices.com\/pagead\/imgclick\/061219083749040728091300?pos=0\" coords=\"1,2,367,28\"\/>\n<area shape=\"rect\" href=\"http:\/\/services.google.com\/feedback\/abg\" coords=\"384,10,453,23\"\/><\/map>\n<p><img decoding=\"async\" usemap=\"#google_ad_map_061219083749040728091300\" border=\"0\" src=\"http:\/\/imageads.googleadservices.com\/pagead\/ads?format=468x30_aff_img&amp;client=ca-pub-1259014363012020&amp;channel=9138153052&amp;output=png&amp;cuid=061219083749040728091300&amp;url=http%3A%2F%2Ftw-india.blogspot.com%2F2004%2F07%2Fstyle-guides-sacrosanct.html\"\/><\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>How many times have you paused and reflected, \u2018man, I know I am right, but the style guide does not agree\u2026\u2019? For example, some style guides proscribe the use of the possessive pronoun noun (earlier I had written &#8216;pronoun&#8217;. Thanks Guy for pointing it out.) and demand that you elaborate: IP address of the Server [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"ngg_post_thumbnail":0,"_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_post_was_ever_published":false},"categories":[1],"tags":[195],"class_list":["post-64","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-uncategorized"],"jetpack_featured_media_url":"","uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"jetpack-portfolio-admin-thumb":false},"uagb_author_info":{"display_name":"Suman Kumar","author_link":"https:\/\/sumankumar.com\/blog\/author\/suman-kumar\/"},"uagb_comment_info":1,"uagb_excerpt":"How many times have you paused and reflected, \u2018man, I know I am right, but the style guide does not agree\u2026\u2019? For example, some style guides proscribe the use of the possessive pronoun noun (earlier I had written &#8216;pronoun&#8217;. Thanks Guy for pointing it out.) and demand that you elaborate: IP address of the Server&hellip;","jetpack_shortlink":"https:\/\/wp.me\/p2Gbk8-12","jetpack_likes_enabled":false,"jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":917,"url":"https:\/\/sumankumar.com\/blog\/2006\/09\/ndtv-interviews-ravages\/","url_meta":{"origin":64,"position":0},"title":"NDTV Interviews Ravages","author":"Suman Kumar","date":"September 14, 2006","format":false,"excerpt":"I don't know if it was my post or serendipity or providence but Alaphia chose to interview Ravages!Most journalists seem to have a problem with the possessive noun and pronoun. Hm.","rel":"","context":"In &quot;blogs&quot;","block_context":{"text":"blogs","link":"https:\/\/sumankumar.com\/blog\/category\/blogs\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":844,"url":"https:\/\/sumankumar.com\/blog\/2005\/12\/is-your-boss-a-psychopath\/","url_meta":{"origin":64,"position":1},"title":"Is your boss a psychopath?","author":"Suman Kumar","date":"December 14, 2005","format":false,"excerpt":"(Via FastCompany):\"The standard clinical test for psychopathy, Robert Hare's PCL-R, evaluates 20 personality traits overall, but a subset of eight traits defines what he calls the \"corporate psychopath\" -- the nonviolent person prone to the \"selfish, callous, and remorseless use of others.\" Does your boss fit the profile? Here's our\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":46,"url":"https:\/\/sumankumar.com\/blog\/2003\/12\/46\/","url_meta":{"origin":64,"position":2},"title":"Usability Testing of Your Documentation\u2026","author":"Suman Kumar","date":"December 21, 2003","format":false,"excerpt":"Usability Testing of Your Documentation Yea, it is possible. Let's say you have created a user-guide. The user-guide is aimed at helping users in performing various tasks on the product. Choose a representative user (anyone, even your mother-in-law is all right). If you can't recruit a user read List-item: Ask\u2026","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":749,"url":"https:\/\/sumankumar.com\/blog\/2005\/06\/digital-camera-buying-guide\/","url_meta":{"origin":64,"position":3},"title":"Digital Camera Buying Guide","author":"Suman Kumar","date":"June 15, 2005","format":false,"excerpt":"Shopping for a digital camera is stressful. Most stores carry a fraction of the 200-plus cameras on the market, and except at specialty stores, salespeople aren't much help. You can ask friends for recommendations, but even if they love their camera, it might be discontinued, given short product cycles. Don't\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":40,"url":"https:\/\/sumankumar.com\/blog\/2003\/09\/40\/","url_meta":{"origin":64,"position":4},"title":"Joel on Software - The\u2026","author":"Suman Kumar","date":"September 18, 2003","format":false,"excerpt":"Joel on Software - The Guerrilla Guide to Interviewing How to weed out the 'unwashed masses'? How to discover and hire the brilliant superstars? Read on: Joel on Software - The Guerrilla Guide to Interviewing","rel":"","context":"In \"Uncategorized\"","block_context":{"text":"Uncategorized","link":"https:\/\/sumankumar.com\/blog\/tag\/uncategorized\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":510,"url":"https:\/\/sumankumar.com\/blog\/2004\/01\/the-airtel-guide-to-how-to-torment-your-customers\/","url_meta":{"origin":64,"position":5},"title":"The Airtel guide to &#8216;How to torment your customers&#8217;","author":"Suman Kumar","date":"January 5, 2004","format":false,"excerpt":"The Airtel guide to 'How to torment your customers' This is the fourth post by me on Airtel's utter incompetence and unabashed insensitivity towards its customers ( Read related article here). I took off for my Christmas holiday on 24th December. On 27th I get a message from Airtel stating\u2026","rel":"","context":"Similar post","block_context":{"text":"Similar post","link":""},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts\/64","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/comments?post=64"}],"version-history":[{"count":0,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/posts\/64\/revisions"}],"wp:attachment":[{"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/media?parent=64"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/categories?post=64"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sumankumar.com\/blog\/wp-json\/wp\/v2\/tags?post=64"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}