Basics of Technical Writing
This refers to the oral and written communication for and about business and industry.
Technical Communication
A document that summarizes the progress, outcomes, and key details of a project.
Project Report
Ensuring the writing is easy to understand and free from ambiguity
Clarity
An incomplete sentence that lacks either a subject or a verb, making it grammatically incorrect.
A company is creating a user manual for a new software program. What is the primary goal of this document?
A. promoting the software’s brand
B. explaining how to install and use the software
C. discussing the company’s history
D. comparing it to previous software versions
B. explaining how to install and use the software
TRUE or FALSE
You should always use highly technical terms in technical communication.
FALSE
A detailed account of an event or series of events, presented in a structured format, focusing on chronological order and factual description. It typically provides context, actions taken, and outcomes.
Narrative Report
Expressing information in as few words as necessary without losing important information.
Conciseness
Specialized terms used within a particular field, often difficult for outsiders to understand
Jargon
A healthcare provider is writing discharge instructions for a patient. What should be the primary focus of the document?
A. offering alternative treatments
B. discussing the patient’s condition in medical terms
C. providing a history of the patient's illness
D. clearly explaining medication and follow-up care
D. clearly explaining medication and follow-up care
This is writing focused on professional communication, including emails, reports, and proposals, for internal and external business purposes.
Business Writing
A document that details the facts, events, and circumstances surrounding an unexpected occurrence, such as an accident or equipment failure, for record-keeping and analysis.
Providing specific, detailed, and tangible information rather than vague or abstract terms. For example, instead of writing the word "very small" for a very small object, a technical writer might use the words "minuscule" or "minute" to describe it.
Concreteness
A descriptive phrase that does not clearly and logically relate to the word it's supposed to modify, causing confusion.
Dangling Modifier
A team leader is preparing a post-project report for stakeholders. What is the main purpose of this report?
A. to document project challenges and how they were overcome
B. to showcase the team's individual achievements
C. to propose new projects based on current success
D. to communicate project results and outcomes clearly
D. to communicate project results and outcomes clearly
TRUE or FALSE
Business communication and Technical communication are synonymous.
FALSE
A guide that provides step-by-step instructions for using a product or performing a task.
Manual
Using uniform terminology, style, and structure throughout a document.
Consistency
The department responsible for managing employee relations, recruitment, and compliance with labor laws.
Human Resource
An HR manager is creating an employee handbook. What is the most important aspect to include?
A. the company’s history and mission
B. details on workplace policies and procedures
C. profiles of key employees
D. a glossary of industry terms
B. details on workplace policies and procedures
What do you call a professional who creates documentation such as manuals, guides, and reports to explain complex technical information clearly?
Technical Writer
A document that provides an overview of a company's financial performance, including income, expenses, and profitability.
Employee Handbook
Including all necessary information to fully inform or instruct the reader.
Completeness
A significant point or event in a project that marks progress toward a goal.
Milestone
A legal advisor is drafting a contract for a new business partnership. What is the most important factor to focus on?
A. the company's values and culture
B. clear terms and conditions of the partnership
C. personal information about the parties involved
D. a history of the companies involved
B. clear terms and conditions of the partnership