RE: Capitalizing...research need

Subject: RE: Capitalizing...research need
From: "Broberg, Mats" <mabr -at- flir -dot- se>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 15 Feb 2005 09:39:33 +0100


> My experience with IM is that there are definitely some ideas
> there worth implementing. What concerns me about it is the
> tendency of people I have met who have taken the training to
> sound a bit like Scientologists when they talk about it...
>
> Gene Kim-Eng

Also, it usually needs to be adapted to one's specific needs (although
the IM Scientologists would flame me for saying something like that...
:)

I attended a course some time ago and after having implemented IM in
some of our documentation I realized that some ingredients in IM simply
don't work in a real-life industrial documentation situation - and even
annoys readers.

For example, according to the IM course material all figure blocks in a
structure map need to be introduced with something similar to "This
figure shows...". That is all and well when figures are not
selfexplanatory but is extremely annoying for the reader when it is
obvious what the figure displays.

Also, procedural blocks need to be introduced with something like "This
producedure explains...", which creates the same annoyance if the
procedure is selfexplanatory. Not to mention the same kind of
introductory sentence before a callout table below a simple figure. It's
unnecessary to state the obvious!

I enjoyed attending the IM course and felt that it gave me new methods
to structure my documentation, but - as all religions - one should not
accept it without criticism. Some things definitely need to be tweaked
in order to make it work better.

Best regards,
Mats Broberg
Technical Documentation Manager
www.flirthermography.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: CONTEXT macro package
Next by Author: Comments highlighting disappeared
Previous by Thread: Re: Capitalizing...research need
Next by Thread: Re: Capitalizing...research need


What this post helpful? Share it with friends and colleagues:


Sponsored Ads