Essay Instructions: TECHNICAL INSTRUCTIONS PAPER
This paper assignment does not merely entail copying information or procedures from manuals at work or in the library. No photocopied charts, diagrams, or anything else will be accepted along with your paper-unless you generate them from scratch on the computer or by hand. THIS PAPER IS NOT MERELY A SUMMARY OR PARAPHRASE OF TECHNICAL INFORMATION. Even though technical support and reference is expected and required to some degree, we expect you to be professional and write about something you can explain thoroughly and/or perform with little aid of books or manuals. In short, choose a topic for which you have a strong grasp, a strong knowledge, and a strong understanding.
Be sure to compose an original document with thought, analysis, and discussion. Read, think critically, analyze, and then write your paper.
THE ASSIGNMENT:
Choose a job-related task, procedure, process, or high tech machine operation/function-a topic with complexity and depth of analysis-and write a 5-page instructional paper explaining thoroughly the action. Write this for what can be considered a college-educated audience, not just for those within your field of study or at work.
PAPER LENGTH: 5 Pages content, not including diagrams, charts, tables, reference pages, etc.
Please realize that you will use traditional paragraph writing along with various kinds of lists and diagrams to explain your topic. Document using APA style and, if you can draw or can use computers creatively, create original charts or diagrams if this helps the reader visualize.
INSTRUCTIONS:
A very large and important portion of technical writing projects fall into the category of instructional writing. Some examples of this mode of writing include recipes and simple "how to" topics WHICH ARE NOT ACCEPTABLE FOR THIS ASSIGNMENT. The examples below are merely examples of the instructional mode of writing in daily living.
1.Computer software and home audio and video manuals
2.Bicycle assembly instructions
3.How-to books for home maintenance and renovation
4.Procedure and job task guides in any profession
5.Directions to geographical location
6.Automobile maintenance and repair
Many failures in technical writing are due to lack of defining or explaining terms, processes,and functions. As with anything, definitions are a product of audience and purpose. Always remember to define anything, which any portion of your audience might not understand, especially if the failure to understand would lessen the chances of accomplishing your purpose.
Your paper should not reflect a narrative style. Present information in a more instructional and expository style.
Eliminate "I" usage-For example: "I started my process by..." Instead try, "Start your process by..."
Use subheadings, numbering, bullets,outlining, bolding key words, a glossary, etc.
Watch verb tenses,and don't have your paper read only as a summary of the research information. Include more of your writing, analyzing, explaining, discussing, etc.
SCENARIO:
One day you are at work, the boss comes up and taps you on the shoulder, you turn around and there is a brand spanking new employee which still has brand-new stamped across their forehead. And you are told your job, what you need to do now, is to teach this person how to do a function of your position. If you are a claims adjuster, how do you fill out a form. If you are a nurse, how do they work a particular piece of equipment. Make sure it is something significant, don't have it something as basic as this is how you sign your name. Make sure it is fairly complex, technical and detailed. Do remember that it is vital that this paper be well organized in a chronological order. Start at the beginning and go straight through to the end.
Anticipate problems and questions, if I get an error message what do I do? You need to anticipate and cover this in your paper, (this is what you would do to correct the error message). Define your terms, don't assume that this new person knows the terminology as well as you do. Your paper should include paragraphs of narrations and lists, use bullets, headings, numbered lists, etc. Break your usage so it is easy to follow. Make it so you could follow it if you were brand-new.
Don't just give paragraphs of narration or just a series of lists, or just an outline, but a combination of narration and list. Make sure it is comprehensive, complete and accurate. It is vital that this paper is organized in a chronological order.
A suggestion for a piece of equipment to write about might be medical equipment such as an Automated External Defibrillator (AED). This equipment has become available now in many locations (hospitals, ambulances, airplanes, nursing homes, factories, and offices, they are anywhere someone wishes to purchase one to help someone experiencing a heart attack). This equipment can vary however, because manufacturers build differently and even change their own model features. A description of one model that could be found in an office setting, might be such a piece of equipment that I might have to explain to that new employee.