TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Any ideas for a presentation on the documentation process?
Subject:Re: Any ideas for a presentation on the documentation process? From:Jo Baer <jbaer -at- mailbox1 -dot- tcfbank -dot- com> To:John Posada <jposada01 -at- yahoo -dot- com> Date:Fri, 22 Oct 1999 11:51:49 -0500
One of my high school English teachers gave the class a similar
assignment, but the topic was tying a shoe. Believe it or not, one of
the main problems documenting this process was terminology. What are
those things on the ends of your shoelaces? (Aglets, if you really want
to know.) As John suggested, while one person read the shoe-tying
procedures, another person attempted to tie the shoe according to the
procedures given. Very few shoes were tied, and the point was made.
John Posada wrote:
>
> Give everyone a sealed jar of peanut butter, a sealed
> jar of jelly, a couple of slices of bread still in the
> bag, and a knife. Tell them to write down the process
> to make a couple of sandwiches, then have their
> neighbor use the own process word for word to make
> their lunch.
>
> Tell them that this is what you do all day, every day,
> with processes that are WAY more complex than
> something any six year old can do.
>
> > I and a writer in my group are going to give a
> > presentation on the
> > documentation process to the engineers and probably
> > some marketing people.
> > Has anyone had any luck doing the same thing or any
> > ideas on how
> > to make it interesting?