Thursday, September 6, 2012

Why is Technical Writing So Terrible?

Here are some facts. Cold hard facts. Cold,cold, hard, diamond-hard facts. Which I've just made up. Actually, they're more vast generalisations than anything else, but if I call them facts, you'll be more impressed.

(i) people who work in IT sometimes find it difficult to write things down clearly. (ii) as a result, technical writing has a tendency to be awful.

In some cases, the poor standard of technical writing is down to a lack of objectivity. If you're a developer and you've spent 2 long years hand-coding an application, it's going to be very difficult to step back and write a user manual that doesn't use all the buzz words and phrases that you've been using for the last 2 years. A poor manual ensues, then. Also, and this is dangerous territory: some people, not all, but some people who work in IT don't actually communicate very well. This includes writing stuff down, unfortunately. So anyone who is highly involved in, say, virtualised server environments might not be able to communicate effectively all the pros and cons of virtualisation. Or they might be able to tell you what those pros and cons are, but not in a cohesive and interesting way.

Why is Technical Writing So Terrible?

It's in situations like this that a professional writer should be used. If it's explaining the ins and outs of cloud computing environments or writing a beginners' guide to application X, the combination of an objective eye and professional writing standards can make the difference between a product or service failing or succeeding.

So often, technical writing is peppered with jargon and technicalities, and sometimes, that's all well and good. No-one wants a Cisco guide to firewalls for instance to be written in such a way that could make it everyday reading; after all, it's not an everyday subject. Sometimes, jargon and buzz phrases are absolutely necessary for a document. It depends on the intended audience to a greater extent. But a guide for middle management on how to choose a hosting provider does need to be written in such a way that it can be understood by the fiercely non-technical.

So technical writing can be fairly dire because of a misunderstanding as to the intended audience. It can be dire because of lack of objectivity. And it can be awful because the person who wrote down the words just doesn't write words down very well.

In any case, a professional copywriter should be used to help matters out. But the writer needs to be knowledgeable enough about the subject matter to be able to get a good grip on the subject. The best writer in the world is going to make a hash of a body of work on middleware if he or she isn't quite sure what middleware is. What's required is that rare breed: a writer who can communicate highly effectively and who can understands all things technical too.

Why is Technical Writing So Terrible?
Check For The New Release in Health, Fitness & Dieting Category of Books NOW!
Check What Are The Top Cooking Books in Last 90 Days Best Cheap Deal!
Check For Cookbooks Best Sellers 2012 Discount OFFER!
Check for Top 100 Most Popular Books People Are Buying Daily Price Update!
Check For 100 New Release & BestSeller Books For Your Collection

Joe Green. Unscribble Copywriting. See [http://www.unscribble.com]. When your copy is well written, your business will benefit from increased sales and a greater number of sales enquiries.

cell phone watches New Black Seed Black Seed Oil 8 Oz

Monday, September 3, 2012

Technical Writing - Wurman's LATCH Concept of Organizing Information For Technical Documentation

Technical writing has its mechanical aspects that need to be mastered. A good technical writer must know how to use English effectively as well as various software products to produce acceptable technical documents.


Direct Dealer Stores Zone
24 Hrs Best Seller Category
New Tags Get Cheapest Price Shopping
Benefit Buy Direct Directory
Inter Brand Search
My Shopping Centre
Online store Review Directory
Only New Release Products

But I wish technical writing was that simple. The hardest part comes before one even sits down in front of a computer to type the first word.

The hardest part in documenting anything is organizing the information in a way that makes sense from the user's point of view.

Technical Writing - Wurman's LATCH Concept of Organizing Information For Technical Documentation

If, for example, you are documenting a software package, are you going to introduce installation first, configuration next, and operation the last?

Or are you perhaps going to introduce the way software is installed in different factory sites and organize the information around such geographic markers?

If you are writing a manual about dogs, are you going to introduce them according to their size, country of origin, temperament, or what?

Richard Saul Wurman, a legendary technical communicator who has written extensively about the issue, has introduced the LATCH concept, an acronym made up of the first letters of the following information organization principles:

- Location
- Alphabet
- Time
- Category
- Hierarchy

Wurman claims that ANY INFORMATION can be categorized neatly along these 5 dimensions and he may be right about that. It's just a useful tool to keep in mind when you are trying to decide how to make sense of your subject matter.

For example, if you're writing a City Guide, you can of course use L (Location) easily and divide the guide into districts, neighborhoods, etc.

Once you do that, you can switch to T (Time) perhaps and talk about what is "old and historic" and what's "brand new" in every location.

How about C (Category)? "Residential" versus "Commercial"? Or "Downtown" versus "Suburbs"?

The possibilities are infinite of course.

So the next time you need to organize information, it might save you time and energy to start with LATCH dimensions and see which ones serve your documentation goal the best.

Technical Writing - Wurman's LATCH Concept of Organizing Information For Technical Documentation

Ugur Akinci, PhD is a Fortune 500 Senior Technical Writer who loves to share his technical writing tips, tutorials and advice with those who subscribe to his FREE Technical Writing Tips email list at http://www.learntechnicalwriting.com.

Subscribe and download your FREE Special Report "How Much Do Technical Writers Make?" today!

mobile phone watches Save On Blueant F4 Motorcycle Helmet Bluetoothheadset Cellular Low Price Plyometric Platform Box Set 12 Save On Diode Led Di 0187 Fluid View