Technical Writing Project

Scenario

In this project, you will demonstrate your mastery of the following competency: Create written technical communications for various purposes and targeted audiences.

Scenario

You work in your current workplace (or a past or future workplace if you prefer). Your direct supervisor has let you know that the company is trying to get its “ducks in a row,” and is thus reviewing job functions as well as employees’ understanding of the company. They are asking certain employees to complete a set of technical writings; you’ve been asked to complete an executive summary (with a complementary graphic idea), a letter, an HR exit interview, and a short “elevator speech.” Each deliverable should show a clear understanding of its audience, the organization you work for, and the craft of technical writing.

Directions

You will complete the following documents:

• Executive Summary: Synthesize your company’s informational documents into a onepage executive summary of your company. Make sure to include relevant organizational information.
• Letter: Write a one-page letter to your supervisor that describes how to improve your current position/role.
• Interview: Write a seven-question exit interview that includes open-ended questions a human resources officer would ask you if you were leaving and give your responses to those questions. Include a paragraph explaining why these are key questions for the company to obtain feedback on.
• Speech: Write a 30-second “elevator speech” or “pitch” about your company that would interest and intrigue someone

Ensure each piece follows these standards:

1. Use specific terms that convey domain-specific information as appropriate for the audience. To do this well, consider the following:

a. What technical terms would the audience need to know?

b. What internal processes could be explained?

c. Are there acronyms that need to be explained?

d. What are keywords for your profession?

e. What are keywords for your position?

f. What words or phrases are used daily or weekly that an “outsider” wouldn’t easily understand?

2. Organize effectively for the technical communication format. To do this well, consider the following: a. How is this format organized?

a. List?

b. Chronological?

c. Beginning/middle/end?

d. Question and answer (Q and A)?

3. Align communication to the purpose of technical communication. To do this well, consider the following:

a. What is the purpose?

b. Does the communication meet the purpose?

c. How could I change the communication to fulfill the purpose?

4. Direct communication to the audience of the technical communication. To do this well, consider the following:

a. Who is the audience (specific or general, as is useful)?

b. What are that audience’s needs?

c. What does the communication need to do in order to meet the needs of the audience?

5. Use tone appropriate to the format. To do this well, consider the following:

a. What tone does this format call for?

b. What are the key characteristics of this tone?

c.How can I ensure my writing displays a professional tone?

6. Use style appropriate to the format. To do this well, consider the following:

a. What style does this format call for?

b. What are the key characteristics of this style?

c. How can I ensure my writing displays a professional style?

7. Employ conventions according to professional standards. To do this well, consider the following:

a. What are the professional standards for conventions?

b. How can I edit to ensure my conventions meet professional standards?

8. Format documents to meet professional standards. To do this well, consider the following:

a. What are the professional standards on how to format this technical communication?

b. How can I edit to ensure my formatting meets professional standards?

For the executive summary, specifically include the following elements:

1. Synthesize information from your company’s source documents:

a. Include at least three sources.

b. Cite the three sources (use the supporting document below).

c. Include no more than one page in your executive summary.

2. Describe a graphic that pairs with your executive summary.

a. Include the idea for a graphic.

b. Ensure the idea is communicated clearly.

c. Does your graphic augment or clarify the executive summary?