In the online technical writing reference for ENG 345, David McMurrey provides a wealth of information about various types of technical reports, including:
- policies and procedures
- recommendation and feasibility
- technical background
- primary research
- business plans
- technical specifications
- user guides
- instructions
McMurrey notes similarities and differences in terms of format and content among technical reports. In the production of such documents, McMurrey also explains that the real focus is on the writing, "how well adapted to a specific audience it is, how clear and readable it is, how it flows, how it's organized, how much detail it provides." How well we use various and sundry formatting features is an additional focus.
As we are already familiar with at least three social media tools, this assignment asks for the production of technical documentation for a product, service or topic. Any of the above kinds of technical documentation are appropriate for this assignment. A combination of technical documents is also appropriate, e.g., a technical specifications report about a lightbulb and a set of instructions for installation. Given the focus of this assignment, further research is necessary. There is also an expectation that outside sources will be given appropriate credit. It should be clear, though, what product/service is of major focus. And, unlike the ZGT assignment, the product/service/topic detailed in the technical report must be real. Whether or not any social media tools appear in the production of such technical documentation is up to individual discretion.
The individual technical writing project must include:
- At least 3200 words of original text or appropriate media equivalent (not including table of contents, references, etc.)
- At least two graphics (correctly cited)
- Document and page design suitable to audience and purpose
- MLA in-text citations and bibliography (unless citation format in dominant field is APA or Chicago)
The ultimate project deadline is Week 14, but there are some additional documents required.
Week 7 - Individual project proposal of 800 words due (blogged)
Week 10 - Audience analysis of 800 words due (blogged)
Tuesday, 3.8
Read: TW "Task Analysis"
Student group:
Week 11 - Task analysis of 800 words due (blogged)
Read: TW "Progress Report"
Week 12 - Individual project draft of 3200 words (emailed & hard copy to class session)
Tuesday,
3.22
Project peer review
Week 13 - Individual project progress report due (blogged)
Individual project work
Week 14 - Individual project revision of 3200 words due (emailed)
Tuesday,
4.5
Project debriefing
Each of these documents should first be composed in Microsoft Word or a similar word-processing application to take full advantage of formatting opportunities before emailing to Posterous. Blogging requirements (2 per week due by 11:59pm on Monday and Thursday) will remain in effect throughout this project.