Instr Sets

Untitled (2).jpg

Instruction sets are common technical documents for many disciplines and occupations. Employees read instructions to learn how to assemble a product or complete a procedure. Supervisors write out company policies that oftentimes serve as instruction sets, and customers read instructions for using a product. In spite of the prevalence of user manuals, most are poorly devised and executed.  However, the quality of a manual matters since companies stand to lose both profits and credibility.

The main goal of technical communicators when producing a user manual is to create ease, ease of finding and understanding the information in the document and applying it to the equipment or procedure. Keep this in mind when you write the assignment. For this assignment, your objective will be to create a multimodal professional instruction set for advanced users of Blogs@psu.



Image Copyright 1996 Black Hills SD






Procedure 

You will develop a set of instructions advising users on how to perform a specific technical task. 


Guidelines

  • Choose something you are very familiar with. It can be something related to your field of study (e.g. how to use a particular piece of laboratory equipment), or something related to a more general audience (e.g. how to learn to juggle).
  • Ideally, your audience should be someone who has never performed this task before.
  • Your audience should have a general understanding of the topic area.
  • Choose a task with an appropriate level of difficulty--neither too easy nor too hard to explain in the space allotted.
  • The task may involve a device: assembling it, operating it, or fixing it. Or it may involve some process (e.g., registering using eLion).
  • The process should have discrete parts or steps that are fairly easy to name and refer to.



 

Topics

 Here are some topics that you might want to choose for your project:

How to upload a large file to your web space and link to it from your blog.  Blogs@psu has a limit of 50M for a single file.

 

Note:  If you want to post a large file on your blog (a large podcast, for example), you need to upload it to your web space using a different tool, then link to the file in a new entry. This would include adding a video that exceeds the time limitations on Youtube to your personal space and redirecting it to your blog.

 

Connect your blog to your Flickr account to automatically post pictures your psu blog via email on your mobile phone.

 

Note: The connection information on configuring a third party service/client to work with blogs@psu is here: http://kb.its.psu.edu/article/762

 

Add your blog feed to twitterfeed so new posts automatically 

get tweeted.

Post to blogs@psu directly from word.

 
Changing the color of your blog background
 
Changing the font style of blog headings
 
Removing the main sidebar and expanding the container space
 
Renaming the blog tab
 
Embedding a media player (needs to be completed)
 
Customizing the blog space footer
 
Adding a banner to every page
 
Creating subfolders in the sidebar folder widget



Composing a blog entry in a word doc and eliminating the

gibberish on your home page



Creating a link to move to the top of the page

 
Come up with a project linking your blog site to Facebook
 

          

 Rhetorical Situation

Before you begin to write, consider the rhetorical situation for your instructions. Use the planning worksheet to help you determine the purpose, audience, context, and content for your instructions. People have unique ways of learning. Take the Vark Questionnaire to learn about your style of learning. Now, consider how your audience might best learn.


 Content

 Depending on the nature of your task, you may wish to include some or all of the following contents.


  • Introduction or background information.  

 

What your Introduction Should Include:

  • An overview of the steps needed to complete the task
  • Definitions of terms or concepts they need to know before they proceed
  • Cautions or warnings that apply to the task as a whole
  • A sense of how long the task will take
  • Where they should perform the task  


 

  • List of materials or ingredients needed.

  • Diagrams, drawings, photographs, figures, or tables.

  • Include captions for each illustration or figure.

  • Label charts and diagrams clearly.

  • Make sure to give a sense of scale and orientation.

  • List of steps, in chronological order.

 

Additional Guidelines for Designing an Instruction Set:

      • Make sure you use the imperative mood. ("Attach the red wire.")
      • Phrase each step clearly and concisely.
      • Provide "feedback" that informs the reader what will happen after they complete each step.
      • Include warnings or cautions before readers will encounter problems.
      • Break long lists into sections with appropriate sub-headings.
      • Make sure sub-headings and steps are phrased in parallel form.   
      • Include troubleshooting tips.
      • Provide a glossary of key terms and definitions.




Organization

Instructions are normally organized in a chronological order. Beyond that, here are some other guidelines:

 

What your Design Should Include:

    • A clear hierarchy of headings and subheadings.
    • Well-chosen fonts. For print documents, sans-serif fonts are usually best for headings; serif fonts are best for body text. (For online documents, the reverse is true.)
    • Numbered lists and bulleted lists, where appropriate.  Know the difference. Make sure bullets and numbering are consistently formatted. Do not number or bullet lists with fewer than two items.
    • An appropriate amount of white space--neither too much nor too little.
    • Effective use of alignment. Centered alignment may make it harder for users to skim headings and sub-headings; left alignment or indentations can be more effective for this.
    • Effective use of contrast. Too much contrast means that nothing stands out; too little makes it hard for users to find what they need. Consider emphasizing elements like headings, key words, and warnings.
    • Consistently used design features. Decide which fonts, font sizes, and forms of emphasis you will use and apply them consistently.
    • Length should be about 2 pages single-spaced.

 

 


Files

Planning Worksheet

Audience Checklist

Rough Draft Worksheet

Grading Worksheet


Lego Exercise

Peanut Butter and Jelly Sandwich Exercise

Rolling a Cigarette

Voting Form



Power Point Chapter 19

Chapter 19 Quiz

Chapter 19 M.C. Quiz



Student Work


See Contact Page.


Evaluation


Evaluation Criteria Assignment #5 Instruction set

 

 

 

Excellent

Good

Needs Work

 

content

 

The instructions include all of the information needed to complete the task at hand.  Background information, warnings, and definitions are included where appropriate. The instructions are organized logically. Items within numbered lists are organized chronologically. Sub-sections are clearly marked with headings. 

 

 

 

 

 Format

The instructions include each of the format features. The overall design is clear and consistent. The instructions use fonts, white space, contrast, alignment, headings and sub-headings appropriately and consistently.

 

 

 

 

 organization

 

The instructions are organized logically. Items within numbered lists are organized chronologically. Sub-sections are clearly marked with headings.  


 

 

 

Style

 

The instructions effectively create a professional ethos. The tone is effective for the audience.  Instructions are written as active voice commands. Headings are numbered, and bulleted items are in parallel form (that is, they use similar grammatical structures for each item in a list and for the text of headings).

 

 

 

 

 

 

 

Audience adaptation

and



Mechanics

 

The instructions are appropriate for the intended audience. They're written from a user-centered, rather than system-centered, perspective and in the imperative mood. They anticipate the user's questions, difficulties, and needs.

Spelling, grammar, and punctuation are correct.

 

 

 

 

 

 

 

Participation

 

Attendance, in-class writing assignments, planning worksheet, posted rough draft, and two peer reviews (30% grade).


 

 

 

 



End Note










No TrackBacks

TrackBack URL: https://blogs.psu.edu/mt4/mt-tb.cgi/50819

Leave a comment


Recent Entries

Writing Your About Page
Five Tips for Writing Your About Page,James Chartrand If you're going to put your words on public display, it's your…
Managing your Digital Tattoo
Personal Branding in the Age of Google: Everything you do now ends up in your permanent record. The best plan…
Personal Mission Statements
Go to the following website to build a personal mission statement: Live with Purpose.Or approach your mission statement the…
yeehaw.jpg