Technical writers benefit from regularly updating their knowledge of the digital tools and professional resourcesto them.This week, you will create a 1-2 page How-to Guide or Job Aid on one of the tasks listed below.Option 1: Review the Week 5 final assignment (to produce a user manual). Among other requirements, the manual must incorporate a set of instructions. For Week 1, you may create the set of instructions for that manual. This will save you some time in Week 3 and Week 5 AND garner feedback that can be applied to that final assignment. Check with the instructor if you require any guidance on your topic. AN OVERVIEW OF THE WEEK 5 ASSIGNMENT IS ATTACHEDA screen shot or another image that depicts the function, device or resource and its elements or parts. Indicate where key elements or parts are located (top, bottom, left front, etc.). This fulfills the minimum requirement for a graphic element.Refer to the template for guidance on citing the source of a graphic element.4 to 10 brief instructional steps in a clear sequence; number each stepSafety warning/s or other alerts as indicatedHeadings, subheadings, fonts, colors, boldface, and spacing to emphasize informationOptional conclusion with contact information for technical supportFormat your assignment in keeping with APA standards, including a title page, in-text citations and a list of References.
week_1_rubric_how_to__1_.docx
general_template_for_instructions__1_.docx
finalproject_manual__1_.doc
Unformatted Attachment Preview
Week 1 Rubric ENG/222
Requirements:
•
•
•
Incorporate at least one graphic, such as a checklist, flowchart, diagram, worksheet, etc.;
see
Min. 300 – 350 total words
Brief introductory paragraph stating (as applicable);
o Who the instructions are for (For Option 1: First-time user? Technicians? All
employees? All students? For Option 2: first-time user or novice writer).
o Why the user should perform this task (what will be the outcome or end product?)
o The purpose or function of the tool, device or resource
o When/frequency the task should be performed. Is there a special time or interval or
frequency?
o What tools or equipment are needed? Be specific regarding quantities and sizes.
o How long the task will take to perform?
•
A screen shot or another image that depicts the function, device or resource and its elements
or parts. Indicate where key elements or parts are located (top, bottom, left front, etc.). This
fulfills the minimum requirement for a graphic element (above)
•
4 to 10 brief instructional steps in a clear sequence; number each step
•
Safety warning/s or other alerts as indicated
•
Headings, subheadings, fonts, colors, boldface, and spacing to emphasize information
•
Optional conclusion with contact information for technical support
Criteria
Grammar, spelling,
punctuation.
Submit to Write Point &
Plagiarism Check; post
results with assignment
APA Format
Title page
Page numbers
Double spacing
Save all assignment
document files: Last
name_first initial_title
of assignment
Comment/s
Score
Of 20 pts.
Of 10 pts.
Cite Sources
*In-text citations
accurate and complete
*References list
accurate and complete
Min 1 graphic element
Reader accessibility:
Headings, fonts, etc. to
emphasize information
of 10 pts.
10 pts.
10 pts.
Write instructions for
selected task
60 pts.
Total
Late penalty: 10%
Final score
Of 120 pts.
General Template for How-to Instructions
This template offers general guidance for your assignment. Reference the textbook, especially
Chapter 20.
Your instructions may not require each detail as shown below. Use your best judgment to
determine what the user requires. Research the subject if needed.
•
•
•
Be specific about quantities, time, and degrees. A technician needs exact details, such as
80 degrees Fahrenheit. Consumers may require less specificity, such as an alert that the
device will overheat under certain circumstances.
You may use 2nd person/”you” to directly address the user.
Use APA format for the title page and list of References: 12 pt. font and double space.
Times Roman or Arial.
•
After the title page, you may deviate from APA requirements to emphasize
information, as discussed in the textbook. Use headings, subheadings, fonts, colors,
boldface, and spacing
•
Minimum: one graphic element, such as a checklist, flowchart, diagram, worksheet, etc.;
see Ch. 12 for examples.
o Label and number each graphic image and cite its source, like this: Fig. 1:
Samsung Galaxy S8 (source, date)]. This label can be adjacent to, over or under
the image
•
•
Be sure to cite all sources in the text of the assignment and list of References.
In using this template, delete the instructions and brackets shown below.
How to [
]
[or Using Your
Introduction
In a brief paragraph, indicate the following (as applicable):
]
•
Who the instructions are for: Novice writer? First-time user? All technicians? All admin
assistants? All employees? All students?
•
Why the user should perform this task, what is the purpose or function of the tool, device
or resource? , or what will be the outcome or final product? This may not be necessary if
the reason is obvious, like charging a new phone.
•
When/frequency the task should be performed. Is there a special time or interval or
frequency?
•
What tools or equipment are needed. Be specific regarding quantities and sizes.
•
How long the task will take to perform.
[
Label the image below
].
•
A screen shot or another image that depicts the function, device or resource and its elements
or parts.
•
Indicate where key elements or parts are located (top, bottom, left front, etc.)
Step-by-Step Instructions for [
]
•
Number each step
•
State each step simply; not too much information!
•
Use imperative verb forms when applicable: Fasten the bolt. Plug in the device. Hold
the device steadily.
•
Incorporate additional graphics if needed.
•
Incorporate safety warnings or other alerts if needed
Conclusion (optional)
For a user guide, you may substitute a different heading vs. “Conclusion.” For example,
Now that Your Samsung Phone is Charged
In the conclusion:
•
Provide maintenance or trouble-shooting tips (optional)
•
Provide website or phone number for technical support
References
List all sources in APA style and format
1
University of Phoenix Material
Final Project: Writing a Manual
GENERAL OVERVIEW
For the course final project, you will be writing a 5- to 7-page manual, due in Week 5. Refer to pp. 569 to
571 (Ch. 20) of your text for an example of the elements and style of a manual. (Page count does not
include table of contents, list of illustrations, references, index, glossary or appendices.)
Choose a subject for the manual that is related to your current or previous work life, or to your personal
interests.
If you do not have a subject in mind, you may select one of the following University of Phoenix programs
as the focus of your manual:
•
•
•
Phoenix Connect
University Library
The Center for Writing Excellence
Write the manual with a specific user audience in mind. If you are writing for your workplace, decide if
your manual is written for the entire organization or specific group/s. If you choose a University of
Phoenix program, the audience is students.
For inspiration and further guidance, locate a user manual on the Internet. Check with the instructor via
Private Message is you are not sure if it serves as a good example.
CONTENT OF THE MANUAL
Your manual will include the following sections:
Table of Contents REQUIRED on a separate page
List of Illustrations REQUIRED on the Table of Contents page or a separate page
Introduction [“Front Matter”] REQUIRED
• Statement of device/program with sentence definition. State the brand name as applicable.
• Statement of intended user**;
• Statement of purpose of manual and what the reader will be able to do if he/she uses the
manual*:
• Typographic conventions: For example, what fonts, colors, graphic treatments or symbols are
used to highlight certain information;
• List of tools/materials/equipment needed, as applicable;
• Safety warning/s (with related graphic element)
• See Chapter 20.
2
*Purpose (stated in the introduction): From this list, identify what purpose/s will be supported by
your manual.
•
•
•
•
•
•
•
Training
Installation
Operation
Maintenance
Trouble shooting
Repair
One, some or all of the above
**Audience:
Identify user/s for whom you manual has been developed:
•
•
•
•
•
•
•
All employees or all students
First-time users
New employees or new students
Generalists
Experienced operators
Technicians
Specialists
General Content of a Manual: Based on audience and purpose, the body of the manual may include
the following as needed. Be sure to include the sections that will produce a clear, accurate and
comprehensive manual. Refer to Chapter 20.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Definitions/s;
Descriptions of objects, parts, elements, sections, etc., as applicable. May be replaced with
diagram or other illustration.
Process description/s or procedure/s
Instructions (step by step; numbered: how to).REQUIRED
Illustrations MIN. 1 REQUIRED
Alert/s or safety warning/s.
Analyses
Explanations
Tutorials
Government or industry regulations or standards
FAQs
Demonstrations
Installation REQUIRED IF APPLICABLE
Operation REQUIRED IF APPLICABLE
3
Conclusion [or Back Matter]: REQUIRED
Summary of manual content, including
• Summary statement of intended user an purpose REQUIRED
• Specifications;
• Maintenance or trouble-shooting tips;
• Government or industry standards that the device/system supports;
• Contact/s for maintenance and servicing REQUIRED
• Index.
• Glossary
• See Chapter 20
DESIGN REQUIRED
•
•
•
•
•
•
•
Title page in APA style/format
Table of Contents with page numbers
List of illustrations with page numbers
Headings in APA style/format for title page and
References page
10-12 pt. Arial or Times New Roman. Smaller
font may be used in charts, etc.
AFTER THE TITLE PAGE, TABLE OF
CONTENTS AND LIST OF ILLUSTRATIONS,
you may deviate from APA format to produce
a more realistic manual. See examples in the
textbook and online.
Effective use of white space: provide extra
space between sections or begin a new
page for each section
•
•
•
•
Fonts, boldface, color, etc. to highlight
important information
Visual elements, such as photos, screen
shots, illustrations, charts, graphs, etc. Min.
1 visual element, inserted adjacent to
related information.
Words and/or graphics that signify alerts or
warnings.
In discussion preceding a visual, be sure to
indicate what it depicts. Label each
illustration as Fig. 1, Fig. 2, etc. Use this
model:
Fig. 1: Hamilton Beach blender (source,
date)
…
Purchase answer to see full
attachment
Why Choose Us
- 100% non-plagiarized Papers
- 24/7 /365 Service Available
- Affordable Prices
- Any Paper, Urgency, and Subject
- Will complete your papers in 6 hours
- On-time Delivery
- Money-back and Privacy guarantees
- Unlimited Amendments upon request
- Satisfaction guarantee
How it Works
- Click on the “Place Order” tab at the top menu or “Order Now” icon at the bottom and a new page will appear with an order form to be filled.
- Fill in your paper’s requirements in the "PAPER DETAILS" section.
- Fill in your paper’s academic level, deadline, and the required number of pages from the drop-down menus.
- Click “CREATE ACCOUNT & SIGN IN” to enter your registration details and get an account with us for record-keeping and then, click on “PROCEED TO CHECKOUT” at the bottom of the page.
- From there, the payment sections will show, follow the guided payment process and your order will be available for our writing team to work on it.