Tech Writers

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

Tuesday, 21 September 2004

Writing SI units and symbols

Posted on 02:14 by Unknown
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 school, you'll know the importance of getting your units and symbols right.

Important in SI:



  1. The short forms for SI units (such as mm for millimeter) are called symbols, not abbreviations.

  2. SI symbols never end with a period unless they are the last word in a sentence.



    • RIGHT: 20 mm, 10 kg

    • WRONG: 20 mm., 10 kg.



  3. SI symbols should be preceded by digits and a space must separate the digits from the symbol.



    • RIGHT: It was 300 mm wide. The millimeter width was given.

    • WRONG: It was 300mm wide. The mm width was given.



  4. Symbols always are written in the singular form (even when more than one is meant).



    • RIGHT: 1 mm, 500 mm, 1 kg, 36 kg

    • WRONG: 500 mms, 36 kgs

    • BUT: It is correct to pluralize written-out metric unit names: 25 kilograms, 250 milliliters



  5. The symbol for a compound unit that is a quotient of two units is indicated by a solidus or by a negative exponent.



    • RIGHT: km/h or km·h-1 (for kilometers per hour)

    • WRONG: kmph or kph (do not use p as a symbol for "per".)

    • BUT: It is correct to say or write "kilometers per hour".



  6. The meaning of an SI symbol can be changed if you substitute a capital letter for a lower case letter.



    • RIGHT: mm (for millimeter, which means 1/1000 of a meter)

    • WRONG: MM or Mm (M is the prefix for mega, which means one million; a megameter is a million meters)





Links:

potsdam.edu

poynton.com

lamar.colostate.edu


Write to me: Suman[at]sumankumar[dot]com
Read More
Posted in | No comments

Wednesday, 15 September 2004

Travails of a tech writer

Posted on 21:33 by Unknown
Lot of people ask me what I do for a living. When I say 'Tech writer.' they go, 'What's that?'. And I explain,

'What do you do when you are stuck with MS-Word or Excel?'

'Call the guy that sold me the computer?'

And I'd hide my exasperation and pain,

'No, I mean, it is 2 a.m. and you can't call anyone.'

'What's the big deal? I'll call the next morning, but hey,you haven't told me what you do as a tech writer man.'

And I'd resign saying, 'I write help. Like when you hit F1 on MS-Word, you know?' And my audience would groan, 'ohhhh! Never read that stuff.' A pause. And, 'Is that it?'

There. Do you see my misery?

My audience includes lay people, software engineers, undertakers, tea-tasters, musicians, and my dad. Phew. All you guys, read this:

God I hate writing help files. I'll never be able to be a technical writer. How do those people do it? There are actually technical writing sites that are devoted to the love of the profession. I seriously admire these people. It takes nothing but love and hard work to be good at this (much like C++..?). And all I'm trying to do is make a simple help file on The Regulator. Geez. You'd think I'd have done it by now, 4 days after starting, but no. I only have like one page and a basket full of chocolate wrappings(kidding... we're trying to have the least amount of chocolate available in the house, specifically for situations such as this). So. any suggestions? anyone else wants to help me write this thing? I promise a serious credit in the about :)



To be honest, I've never had to do this before. Sure, I've written many technical documents, but documents that say “click this then you'lll see this so click that to get this” are simply ....ugh!
(via rosherove)






Write to me: Suman[at]techwritersindia[dot]com
Read More
Posted in | No comments

Monday, 13 September 2004

Finding the voice

Posted on 04:18 by Unknown
Excerpt from LOUIS MENAND's review of Eats, Shoots & Leaves: The Zero Tolerance Approach to Punctuation” (Gotham; $17.50), by Lynne Truss.

"Does this mean that the written "voice" is never spontaneous and natural but always an artificial construction of language? This is not a proposition that most writers could accept. The act of writing is personal; it feels personal. The unfunny person who is a humorous writer does not think, of her work, "That’s not really me." Critics speak of "the persona," a device for compelling, in the interests of licensing the interpretative impulse, a divorce between author and text. But no one, or almost no one, writes "as a persona." People write as people, and if there were nothing personal about the result few human beings would try to manufacture it for a living. Composition is a troublesome, balky, sometimes sleep-depriving business. What makes it especially so is that the rate of production is beyond the writer’s control. You have to wait, and what you are waiting for is something inside you to come up with the words. That something, for writers, is the voice."





Write to me: Suman[at]techwritersindia[dot]com
Read More
Posted in | No comments
Newer Posts Older Posts Home
Subscribe to: Comments (Atom)

Popular Posts

  • Comments System: Anyone Can Post Comments Now!
    Folks, I know some of you were irritated by the fact that you had to login (if you're a Blogger user) or post as Anonymous while posting...
  • Microsoft Longhorn Help: Highlights
    "Authors will develop content for "Longhorn" Help using an XML-based markup language called Microsoft Assistance Markup Langu...
  • (no title)
    The User-Friendly Manuals' Website The User-Friendly Manuals' Website
  • (no title)
    Interviewing the Techies My current project involves interviewing the architects, programmers and other experts. Here are some observations:...
  • (no title)
    Role of a Technical Writer: Mail to the TWIN List Let's look at it the other way around . There are still a lot of organizations that do...
  • 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...
  • (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...
  • Hollywood May Hire You!
    Check this out. This is a brilliant observation: >"Screenwriting = Creative Technical Writing"
  • 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...
  • Technical Writing Glossary
    I think this is a neat idea and is an excellent resource for aspirants and practising pros alike. Check it out. http://members.iinet.net.au/...

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)
      • Writing SI units and symbols
      • Travails of a tech writer
      • Finding the voice
    • ►  August (2)
    • ►  July (5)
    • ►  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