Producing Technical Communication

What is a technical document?

Technical Documents

• proposals
• emails
• reports
• podcasts
• help files/instruction manuals
• blogs
• about this pages

Determining audience and purpose will help you compose content; content should differ depending on audience and purpose

Consider the differences

• academic journal article
• press release
• blog post

Characteristics of a technical document

• Clarity
• Accuracy
• Comprehensiveness
• Accessibility
• Conciseness
• Professional appearance (includes visuals)

Review textbook pages 13-15 for analysis of different technical documents: video, blog post, and graphic

Audience

• Primary audience: people to whom the communication is directed
• Secondary audience: people more distant from the writer who may read the document but who will not directly act on or respond to the document
• Tertiary audience: people even further removed from the writer who may take an interest in the document

How will readers use your document?

• The way your reader will read your document (skim, study, edit, use it as a source, etc.)
• Reader's reception of content (format type: video, oral presentation or written)
• Physical environment
• Digital environment (website, mobile app, etc.)

Purpose: What do I want this document to accomplish?

VERBS: authorize, define, describe, explain, outline, present, review, summarize, assess, evaluate, propose, recommend

Be as specific as possible when considering purpose

This online profile presents my professional identity

This online profile presents my current employment status, education, and other professional accomplishments

Examine the purpose, audience, and content of professional bios

Activity!