One form of challenge {that a} tech author is commonly given is to clarify a course of. It may be something from a brief how-to product description to a significant doc that particulars the operation of an advanced machine.
A few attention-grabbing examples that come to thoughts from my very own expertise are a video for technicians on easy methods to use the Rotunda Gasoline Injector Tester/Cleaner and an set up and repair handbook for the KWAUN 4600 Copier. Each required in depth analysis to find out precisely how the machines labored adopted by cautious consideration of the very best methods to put out the processes.
If you do not have loads of expertise with this sort of work (and typically even if you happen to do), it is attainable to fall right into a quantity traps in relation to offering a transparent, concise, and full description of a course of.
It’s important to take into account:
– who your target market is
– what they already know in regards to the topic
– what, if any, expertise they’ve had with the method
– what, if any, expertise they’ve had with comparable processes
– what you may want to clarify both in phrases, illustrations, or each
Your job is to clarify easy methods to make a chunk of toast.
The train in divided into 2 components. They contain the identical course of, however every is directed to a special viewers. It will be good follow to work out the precise steps concerned on this seemingly easy course of. You may even have to change your content material and strategy relying in your target market.
Toaster Particulars:
The toaster is an atypical, two-slice, residence kitchen toaster. It has a slide to push down to begin the toasting course of. There is a “mild to darkish” dial from 0 to 10. It has a separate button for toasting just one aspect for bagels and English muffins.
Train – Half One
Write a step-by-step course of for turning a single piece of bread into a chunk of darkish toast.
The viewers is 18- to 25-year olds who dwell in cities of populations of over 10,000. These cities are situated west of the Mississippi and north of Kentucky.
Train – Half Two
Write a step-by-step course of for turning a single piece of bread into a chunk of darkish toast.
The viewers is 18- to 25 12 months olds who’ve lived their complete lives on an island within the South Pacific with a inhabitants of underneath 500. They’re conscious of however not conversant in electrical energy and indoor plumbing.
After you have written your two processes, examine the options under to see how your work compares. Search for what you missed or what you considered that the options missed.
Options
The duty was to write down a short course of on easy methods to make a chunk of toast utilizing an atypical toaster. Your target market was two very completely different teams of individuals.
Half One – Resolution
It is affordable to anticipate that the primary group, the younger Individuals, are fairly educated about making toast even when, for some purpose, they’ve by no means finished it. That tells you that you would be able to begin at a fairly excessive degree of expertise and familiarity with bread and toasters. What you want to do is stability what they already know with what you want to inform them.
The essential steps in making a chunk of toast for this group would look one thing like this:
1. Take a slice of bread [Graphic A: hand holding a slice of bread]
2. Put it into one of many slots within the prime of the toaster [Graphic B: bread being inserted into a slot in the top of the toaster]
3. Set the “mild to darkish dial” scale from 0 to 10 relying on how toasted you need the bread to be [Graphic C: illustration of the scale with an arrow pointing at one of the numbers]
4. Press the slide all the best way down [Graphic D: fingers pressing slide down with arrow indicating direction]
5. When the toast is completed, it’s going to pop up mechanically [Graphic E: slice of toast sitting in the toaster slot]
Half Two – Resolution
The second target market, the younger folks from the South Pacific island, presents a completely completely different problem. You would not make the identical assumptions of expertise and familiarity. In reality, you must assume that these folks could be completely unfamiliar with the entire idea of creating toast.
It is advisable to begin at a way more fundamental degree.
The essential steps in making a chunk of toast for this group would look one thing like this:
[Graphic A: Illustration of a toaster with the various components called out]
1. A toaster is {an electrical} equipment that should be plugged right into a 120v electrical outlet [Graphic B: illustration of the power cord of the toaster plugged into an outlet with plug and outlet called out]
2. Bread is available in many sizes and styles [Graphic C: a number of illustrations of representative shapes and sizes of bread]
3. To start, choose a single slice of bread that may match into the toast slot [see Graphic D: toast slot]
4. The slice of bread shouldn’t contact both finish of the slot and must be thinner than the width of the slot [Graphic E: illustration of bread slice in the slot]
Notice: If the slice of bread is to thick or too extensive, it might stick within the slot or be burned by the heating parts.
5. Set the “mild to darkish dial” scale from 0 to 10 relying on how toasted you need the bread to be [Graphic F: illustration of the scale with an arrow pointing at one of the numbers]
Notice: The toast will probably be darker (extra toasted) the upper the quantity you choose on the dimensions.
6. Press the slide on the entrance of the toaster down so far as it’s going to go [Graphic G: fingers pressing slide down with arrow indicating direction] and let go of it
Notice: Whereas in operation, the toaster will change into scorching. Don’t contact the toaster whereas it’s in operation.
7. When the bread is completed toasting, the slice will pop up mechanically [Graphic H: slice of toast sitting in the toaster slot]
It is apparent that the strategy and content material could be very completely different for the 2 teams.
Usually talking, the steps within the course of should:
– be in a logical order
– present data that tells what to do subsequent
– present data that tells what to anticipate when a step is accomplished
– present graphics and illustrations that help the textual content
As a tech author, you may’t assume that everybody is aware of the identical issues or is aware of as a lot as you do a couple of course of. You should take into account not solely what the viewers is aware of, but in addition what you are able to do to make their grasp of the method agency.
