The Top Five Mistakes That Companies Make with Regard to Technical Documentation

Written by V. Berba Velasco Jr., Ph.D.


Continued from page 1

A related problem isrepparttar failure to use proper language. Considerrepparttar 128729 case in which many ofrepparttar 128730 readers are not native English speakers—say, when marketing a product in Europe or Asia, or when writing assembly procedures for foreign-born factory workers. In such cases, it may be necessary to keeprepparttar 128731 language fairly simple. If this is not possible—say, when discussing complex details that demand a great deal of precision—one can often compensate by adding some aptly-chosen charts, diagrams or photographs. Either approach can be helpful in making complex text a bit easier to absorb.

4.Not being suitably graphic

It’s undeniably cliché, but true nonetheless—a picture does paint a thousand words. Similarly, a manual that makes judicious use of images and diagrams will be much easier to understand than one that is composed entirely of text descriptions.

Some consider this to be childish and unnecessary. I don’t, and my experience has shown thatrepparttar 128732 majority of users appreciate having these visual guides. Remember; no matter how sophisticated your readers are, they’re still human. Even an intelligent, otherwise careful reader can accidentally miss some important detail, especially when pressed for time.

5.Not striving for excellence

It’s interesting to see how programmers and engineers can strive for excellence in many aspects of their work, yet takerepparttar 128733 exact opposite approach when it comes to documentation. “Who cares about wording anyway?” I’ve heard many engineers say. “We’re not writing poetry or screenplays here. What matters is thatrepparttar 128734 documentation must be technically accurate.”

This is an appallingly short-sighted view. Technical accuracy is indeed important, but so are presentation and style. Few engineers would listen to a job applicant who shows up in a bathrobe and slippers, or a litigation attorney who speaks like a valley girl—and yet somehow, these same engineers expect their fellow techies (or worse, a customer!) to slog through pages of meandering, poorly phrased text. Even matters as fundamental as spelling, grammar and proofreading are often treated as mere annoyances—piddling details that are worth nothing more than a cursory glance.

(To my relief, I have not encountered any such attitudes at my place of employment. I hasten to say this, lest anyone think that I’m complaining aboutrepparttar 128735 people that I work with! No, I’ve found that we all appreciaterepparttar 128736 value of excellence, for which I am always thankful. But I digress.)

Remember: When writing for one’s fellow techies, one should bear in mind that they must often absorb voluminous amounts of information in scant amounts of time. When writing for laymen, one should makerepparttar 128737 text as gentle and easy to digest as possible, lest they become lost in an ocean of geekspeak. Either way, putting a little extra effort into matters of elegance and style can make a world of difference.

I won’t go into detail about what constitutes good writing technique, as that would be beyondrepparttar 128738 scope of this text. Suffice to say that a good programmer or engineer should make sure that his writing is readable and well-organized, and that it flows smoothly from one topic to another.

I would be thrilled beyond belief if I never saw another slipshod manual, or if I never heard another story about companies collapsing due to non-existent documentation. A hopeless fantasy? Maybe. Still, I hope that some techies out there will read this message, and that they’ll take it to heart.

V. Berba Velasco has repeatedly discovered the importance of good technical writing, and the pitfalls that can occur from ignoring its value.

Dr. Velasco currently works as a senior electrical and software engineer for Cellular Technology Limited (Europe, China), a biotech company.


12 Top Tips For Up And Coming Article Writers

Written by Ken Hill


Continued from page 1

Maximizerepparttar profit you get from writing your articles by giving your readers a subscription to your e-zine, or a freebie that they'll find valuable enough to go back to again and again.

9. Once you've written your article, wait a couple of days, and then reread your article.

You might be able to add new points that you might have missed before, add more detail to information you covered in your article, or reword parts of your article that are unclear.

10. Use current topics whether online or inrepparttar 128727 "real world" to get ideas for your articles.

Your articles will be cutting edge and newsworthy, and will have an excellent chance of being published by e-zine publishers and webmasters.

11. Always check and double-check your articles for errors.

Use your spell checker and go over your articles for words you might have omitted, run-on sentences and for faulty punctuation.

Also look for words used incorrectly; for instance, if you used "effect" when you should have used "affect" or if you used "there" when you should have used "their."

12. Submit your articles to article directories, article announcement lists, and to e-zine publishers.

Your submissions, although time consuming if done manually, will help you to successfully get your articles published.

Be sure to submit your articles to my article directory at http://www.netpromarketer.com and to visit http://www.netpromarketer.com/directoriesandlists.html where you'll find a list of article directories and article announcement lists.

For a handy listing of e-zine publishers that want article submissions check out http://www.ezinelocater.com.

Also search other e-zine directories for publishers that want article submissions and submit your articles to e-zines that you are subscribed to that accept article submissions from their subscribers.



Article by writer, Ken Hill. Save loads of time promoting your articles with this powerful, promotional tool for e-zine publishers and article writers. Learn more at: http://www.scstats.com/r.cfm?i=4604


    <Back to Page 1
 
ImproveHomeLife.com © 2005
Terms of Use