Copyright

Creating Technical Instructions Flashcards

Creating Technical Instructions Flashcards
1/24 (missed) 0 0
Create Your Account To Continue Studying

As a member, you'll also get unlimited access to over 79,000 lessons in math, English, science, history, and more. Plus, get practice tests, quizzes, and personalized coaching to help you succeed.

Try it risk-free
Try it risk-free for 30 days. Cancel anytime
Already registered? Log in here for access
Troubleshooting section in technical instruction guide
Provides common problems users experience with a product and how to avoid or fix them.
Got it
Six main parts of a technical instruction manual

1. Title page

2. Table of contents

3. User's guide

4. Safety warnings

5. Troubleshooting

6. Frequently asked questions

Got it
Main purpose of content and structure in technical instructions
To ensure a reader can understand the words and processes described and avoid misuse or injury.
Got it
Purpose in technical writing
Determining this is the first step in writing. For technical instruction, it should focus on identifying and solving potential problems to avoid personal harm or product abuse.
Got it
3 considerations for writing technical instructions

1. Purpose

2. Content

3. Structure

Got it
Technical instructions
Detailed information that guides an individual through using a specific product.
Got it
Honesty in technical writing
Avoiding plagiarism, misleading writing, and technical jargon in instructions to ensure the reader can fully understand each step.
Got it
Fairness in technical writing
Avoiding bigotry or favoritism in writing that may offend readers and instead, attempting to use unbiased and neutral terms.
Got it
Plagiarism
The uncredited use of another creator's work.
Got it
Safety warnings
Government mandated requirements for technical instructions, may be specified at the federal and/or state levels.
Got it
3 types of legality to consider in technical instruction

1. Terms of contract

2. State mandated safety warnings / regulations

3. Federally mandated safety warnings / regulations

Got it
Usability
The ability of a document to convey meaning to a specified demographic.
Got it
24 cards in set

Flashcard Content Overview

Use these flashcards to study and examine the intricacies of technical instruction writing. The set includes the steps for pre-writing, writing, and editing technical guides. You can focus on writing for a specific audience, determining purpose, and addressing important legal and ethical issues. This set will help you study for an exam about technical writing instruction, or help you improve your technical writing skills.

Front
Back
Usability
The ability of a document to convey meaning to a specified demographic.
3 types of legality to consider in technical instruction

1. Terms of contract

2. State mandated safety warnings / regulations

3. Federally mandated safety warnings / regulations

Safety warnings
Government mandated requirements for technical instructions, may be specified at the federal and/or state levels.
Plagiarism
The uncredited use of another creator's work.
Fairness in technical writing
Avoiding bigotry or favoritism in writing that may offend readers and instead, attempting to use unbiased and neutral terms.
Honesty in technical writing
Avoiding plagiarism, misleading writing, and technical jargon in instructions to ensure the reader can fully understand each step.
Technical instructions
Detailed information that guides an individual through using a specific product.
3 considerations for writing technical instructions

1. Purpose

2. Content

3. Structure

Purpose in technical writing
Determining this is the first step in writing. For technical instruction, it should focus on identifying and solving potential problems to avoid personal harm or product abuse.
Main purpose of content and structure in technical instructions
To ensure a reader can understand the words and processes described and avoid misuse or injury.
Six main parts of a technical instruction manual

1. Title page

2. Table of contents

3. User's guide

4. Safety warnings

5. Troubleshooting

6. Frequently asked questions

Troubleshooting section in technical instruction guide
Provides common problems users experience with a product and how to avoid or fix them.
Types of visual aids appropriate for technical manuals
Pictures and informational visuals such as tables, graphs, and charts.
4 steps to adding visuals to technical instruction

1. Find the right location in the text

2. Choose visuals that represent the information in the text

3. Add a label

4. Provide reference in the text

3 steps for pre-writing technical instructions

1. Briefly list all steps

2. Determine safety hazards

3. Pinpoint the audience

3 steps to editing technical instructions

1. Ensure clarity of content

2. Correct spelling or grammar errors

3. Add visual aids where useful

Identify the appropriate tone or voice when writing for a younger audience
Informal voice is acceptable.
Voice in writing
The word choice and method of expressing ideas.
Most adults read at a(n) _____ grade level.
Eighth
3 considerations when determining voice in a technical manual

1. Average reading level of most adults

2. Translations into other languages

3. Expertise level of target audience

User's guide in technical instructions
One of the two most important aspects of technical directions that directs the user through the ways to use a product.
Safety warnings in technical instructions
One of the two most important aspects of a technical manual, this section addresses potential problems or hazards.
Contact section in technical instructions
Usually at the end of a manual, this section provides contact information the user may need for additional comments, questions, or concerns.
Identify the appropriate voice when writing for an older audience
A formal voice is required for writing for older readers.

To unlock this flashcard set you must be a Study.com Member.
Create your account

Unlock Your Education

See for yourself why 30 million people use Study.com

Become a Study.com member and start learning now.
Become a Member

Already a member? Log In

Support