technical writing
nailcutter3
PromptDescribe19Fall.docx( PROMPT: TECHNICAL DESCRIPTION )
In Technical Communication, Mike Markel observes that “[d]escriptions of objects, mechanisms, and processes appear in virtually every kind of technical communication” (549). Experts and laypersons both rely on such descriptions to perform their jobs; for example, to design and build a faster car engine, an engineer must first learn how the various parts of an engine function; likewise, a seismologist cannot interpret the data recorded by a seismograph if he/she does not understand how the machine collects and displays this data.
OBJECTIVE
The purpose of this assignment to write a 5-6 page (not counting the Reference page) description that identifies and analyzes a cutting edge technology in your field for a semi-technical audience (i.e.- they may have basic technical knowledge, but are not experts).
CONTENT
Your description must contain the following elements:
1) Introduction and definition of the technology
2) Background / history of the technology’s development
3) Detailed explanation of each component and how it works
4) On-going / current research [What is being studied now]
5) Applications [projected or actual]
6) Possible direction for future research [You could combine these last two sections.]
TOPICS
The topic must be current, narrow, and technical. It should come from engineering-related issues in your area of expertise. Consult the latest editions of your professional journals. You might look at the lists of seminar presentations in your own departments, the research projects in which your professors are engaged, the panels and papers presented at recent conventions of your professional organizations, or the assignments of fellow students in recent internships and co-op experiences.
Choose a topic in which you are interested and to which you can contribute insights. You might want to discuss your topic briefly with me before you begin researching and writing. For suggestions, see the Possible Topics list, found under Content-Module 3 with this prompt.
FORMAT
|
Length, Margins, & Font |
5-6 pages (you can use single or double-spacing, as long as the document is at least 5 full pages in length), page number in the upper or lower right corner of the page, one inch margins. Please note: the Title and Reference pages do not count toward the 5-6 page total. Use 12-point font (Calibri, Times New Roman, or a similar style). |
|
Title Page |
This page should contain an informative and engaging title, your name, and the date. |
|
Section Headers |
You will need to divide the document into clear sections to help readers easily navigate it. These headers should look attractive and professional.
|
|
Tone & Style |
You will need to use an objective tone for this document, and strive for conciseness. See the Style Quick Guide posted in Module 4 with this prompt for a review of the wordy / weak phrases you should avoid.
|
|
Visual Supplement |
You must include at least one visual (illustration, photo, graph, diagram, etc.). You can design and create your own, or incorporate and cite one from a source. Feel free to use more than one visual if it will help readers better understand the process. |
|
Documentation |
You must cite from at least two credible sources. See the next section for more details on this issue. Be sure to provide in-text and bibliographic citations in IEEE format. Though you can use outside sources to help you create your description, the majority of the writing should be your own. Use the sources only to support or supplement your text.
|
SOURCES
You are not limited on the types of sources you use, but if you draw information from electronic sources, other than electronically accessible technical journals or professional magazines, be sure to evaluate the worthiness of the information by examining the source carefully. Look for links, type of domain, credentials of the author(s), date of posting and updating, and so forth.
Strive for a variety of sources. Check the most current technical encyclopedias, dictionaries, and handbooks, and even your textbooks for background information. Supplement these with the most current information you can find.
LEARNING OUTCOMES
· Successfully apply the elements of effective document design (layout, placement of graphics, etc.) to produce a detailed process description that is accessible to a semi-technical audience
· Apply the research strategies discussed in the readings and in class to effectively gather and assess the credibility and usefulness of potential resources.
· Strengthen your critical thinking and analytical skills.
· Write concise sentences and avoid weak verb phrases (see the Style Quick Guide under Content-Module 1)
· Demonstrate your ability to write formal English using correct grammar.
· Practice creating in-text and bibliographic citations using IEEE format.
DUE DATE & SCORING
2
