Instructions
Every technical document should consist of several key characteristics:
- States a problem or issue to resolve
- Addresses the intended audience
- Reflects organizational goals and culture
- May have several contributing authors
- Uses effective design
- Consists of text, images, or both
- Is honest, clear, accurate, comprehensive, accessible, concise, and professional
Step 1: Choose an Example
For this activity, choose one of the following examples to critique:
- Proposal (Links to an external site.)
- Instructions (Links to an external site.)
- User Guide (Links to an external site.)
- Recommendation/Feasibility Report (Links to an external site.)
- Technical Report (Links to an external site.)
- Technical Specification (Links to an external site.)
Step 2: Analyze the Example
Analyze the example carefully to determine whether it meets the technical document characteristics noted above.
Step 3: Craft Your Initial Response
Your initial response must include two elements:
1. Your personal introduction, in which you tell us
- your preferred name, **(ANSWER IS SIN)**
- your degree program, and **(ANSWER IS BACHELOR OF SCIENCE – LIBERAL ARTS
Major/Concentration: Logistics Operations Mgmt)** - the job role you see yourself pursuing after you graduate from Excelsior College. **(ANSWER IS LOGISITIAN)**
2. Your technical document analysis, in which you tell us
- one way in which the document meets characteristics of technical writing you have learned about thus far,
- one way in which the document fails to meet those characteristics, and
- your assessment of the overall effectiveness of the document.