|
Every company goes through quarterly, semi-annual, and yearly cycles.
During these cycles, large, long-term projects are proposed.
After a proposal has been accepted, the actual work begins. However, most new
ideas when presented need a how-to manual to accomplish whatever task has been proposed.
Your project has two phases. First you will write a formal proposal,
outlining either a operations manual, a user manual, or a maintenance manual for a project
you have in mind. Second, after your proposal has been written, you will write the actual
manual. "Through documentation in the the manual, the elements of a
process or mechanism are defined and described, and instructions for its use are
provided" (Shelton 137). Thus the skills you have gained in writing class will
be put to use.
The parameters of the manual:
 | A formal proposal indicating the process or mechanism you will write
about submitted to your instructors by.
|
| Once you have received the go ahead, you will submit an outline of your
manual to your instructor by 5/11.
|
| You will post a copy of the manual your group, so that a peer
group member can peer edit.
|
| You will send the first draft to your instructor for comments.
|
| The final manual should be 10 to 15 pages in length. It is due
6/12.
|
While we are concerned with the final product, we are also trying to model
the way actual complex tasks are completed. Thus, the process is as important as the
product. When you are choosing a topic for your project, we suggest being practical and
using something that is in your scope. Ask one of your instructors if you can write
a manual for the class, or if you work, find something that needs a procedure manual at
work and write about that. We do not want this to be an onerous task; however, we do
want you to understand and learn skills that will aid you in your career.
Include these items when submitting the final manual:
| Title cover page
|
| Preface/introduction
|
| Table of contents
|
| Description of mechanism (if any)
|
| What's need for the process
|
| Instructions for following the process
|
| Appendix with appropriate designs or diagrams
|
| Glossaries defining specialized terms
|
| A copy of your final proposal
|
If you have questions or need help, let us know. In addition, we
have a few hardcopies of former reports if you would like to look at them. |
