Tech Writers

  • Subscribe to our RSS feed.
  • Twitter
  • StumbleUpon
  • Reddit
  • Facebook
  • Digg

Wednesday, 28 July 2004

Style guides: Sacrosanct?

Posted on 02:13 by Unknown
How many times have you paused and reflected, ‘man, I know I am right, but the style guide does not agree…’?



For example, some style guides proscribe the use of the possessive pronoun noun (earlier I had written 'pronoun'. Thanks Guy for pointing it out.) and demand that you elaborate: IP address of the Server as against Server’s IP address . In certain contexts I prefer the latter; for it is shorter and I am sure it won’t confuse the users. But the style guide does not agree.



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.

You thoughts?

Some style guides...

The American Psychological Association (APA) Style


Columbia guide to online writing


Lynch Guide



Write to me: Suman[at]techwritersindia[dot]com
Email ThisBlogThis!Share to XShare to Facebook
Posted in | No comments
Newer Post Older Post Home

0 comments:

Post a Comment

Subscribe to: Post Comments (Atom)

Popular Posts

  • Localization and Internationalization
    Localization and Internationalization Internationalization: Writing in a neutral, simple language so that the document can be translated to...
  • New resources for tech writers in India
    People I have added a 'Classifieds' program to this site. It is in beta. I am just testing it. Give it a spin at Job Ads and also s...
  • Use it before you write it.
    From the Nikkor ED 80-400mm f/4.5-5.6D VR Review (emphasis is mine): [quote] Here's the warning in the manual : "When the camera is...
  • Firefox: Tech writer friendly!
    Firefox has an in-built popup blocker. Firefox saves your screenspace through its tabbed-browsing feature. Firefox allows for opening mult...
  • Writing SI units and symbols
    Quite a few of us do not write the SI units correctly. If you are a Physics or Chemisty student, and still remember what you studied in scho...
  • (no title)
    AECMA Simplified English What Is Simplified English? AECMA Simplified English is a writing standard for aerospace maintenance documentation...
  • (no title)
    How to save your client $1600 per task per year through Usability Testing I have noticed quite a few mails asking how to conduct a usability...
  • Re: [twin] Course Content for Technical Writing
    Hi Your hard skills are okay. But you are not specific when you say 'team skills' I mean today everyone is expected to be a team pla...
  • (no title)
    Help: How helpful is it? I read on Usable Help: "According to the 2002 National Assessment of Adult Literacy , about 50% of the US adul...
  • (no title)
    Web Writing From Sun.com: You can double the usability of your web site by following these guidelines: for two sample sites studied in Sun...

Categories

  • conferences
  • contigency design
  • culture
  • design
  • error messages
  • google
  • hall of shame
  • ideas
  • management
  • manual
  • standards
  • stc
  • strategy
  • tools
  • usability
  • writing

Blog Archive

  • ►  2009 (1)
    • ►  February (1)
  • ►  2008 (5)
    • ►  November (1)
    • ►  September (1)
    • ►  May (2)
    • ►  April (1)
  • ►  2007 (7)
    • ►  October (1)
    • ►  August (2)
    • ►  June (1)
    • ►  March (1)
    • ►  January (2)
  • ►  2006 (10)
    • ►  November (2)
    • ►  October (3)
    • ►  September (1)
    • ►  August (3)
    • ►  June (1)
  • ►  2005 (17)
    • ►  December (2)
    • ►  November (1)
    • ►  October (3)
    • ►  September (2)
    • ►  August (3)
    • ►  June (2)
    • ►  May (1)
    • ►  April (2)
    • ►  February (1)
  • ▼  2004 (32)
    • ►  December (4)
    • ►  November (1)
    • ►  October (3)
    • ►  September (3)
    • ►  August (2)
    • ▼  July (5)
      • Wanted: Sr Technical Writer for Informatica Corpor...
      • Style guides: Sacrosanct?
      • Wanted: Technical Writers for Wipro Technologies, ...
      • Job openings for young under-grads and graduates i...
      • Installing a gas stove: Why I think technical writ...
    • ►  June (3)
    • ►  May (1)
    • ►  April (5)
    • ►  March (2)
    • ►  February (1)
    • ►  January (2)
  • ►  2003 (42)
    • ►  December (2)
    • ►  November (3)
    • ►  October (1)
    • ►  September (3)
    • ►  August (7)
    • ►  July (2)
    • ►  June (1)
    • ►  April (4)
    • ►  February (4)
    • ►  January (15)
Powered by Blogger.

About Me

Unknown
View my complete profile