Instruction Paper
LOW STAKES EXAMPLES FROM THE CLASS, Friday Apr. 24, 2020
TF comments are in bold, but I welcome your comments in the comments section:
[I think that we basically have the whole instructions, or maybe most of them, since there might be a concluding warning about how to avoid injury and I think that these instructions are clear enough that even I could do it. Hmm, if I have time, maybe I will!]
***********
How To Use A Butt Splice Connector
[This is a very clear, concise, precise account of the purpose of this connector and items used; it is very suitable for an introduction. There are no grammatical issues.]
************
Please note: Keep saved files only AND Remove all are bolded by the writer; I have done other bolding:
Step 2: Launch the tool [You need to mention what the tool is in step 1; you probably know that you can alternate between the name and "the tool," but I'm just saying it for everyone's benefit.] and select any one option from the prompt on your screen. Choose the option Keep saved files only to keep all personal files -or- choose the Remove all option to delete all files. [In this case, bulletin points for these 2 items would be easiest to read. If other class members disagree with me on this, speak up.] (Warning: In any case, this tool will perform a complete re-installation which will remove all manually installed applications in order to install new built-in apps. [This sentence is a little challenging for some average readers. I don't think the phrase "In any case" is necessary, but also you should put "will remove... applications" first and then the part about re-installation; This tool will remove all ... built-in apps, This will be a complete re-installation.] It will reset all personalized settings and change to default settings which may affect the overall performance of your device) [Do you want to tell them HOW it will affect the overall performance? Would that be helpful?]
************
To watch my video on the Instruction Paper, please click on this link:
https://youtu.be/jtNSWG8tYEI
I am inclined not to post a sample set of instructions, as I promised to do on the course schedule, because there are so many differences in products that any 1 or 2 examples of the Instruction Paper could not cover the whole range.
During this time of isolation for some of us, and a time when those of us who have to leave home to go to work don't have time to do homework when they're on the job, it's best to look around your home for the subject matter of the Instruction Paper, which is longer, more involved, and more technical than what you've done so far. Your paper might deal with installation, use, or repair of:
computer software
" hardware
involving a:
desktop
laptop or tablet
I-phone
robot
If you're going to be an engineer involved in household product development, think about a:
TV
CD player
toaster oven
radio
microwave
washing machine dryer
Some of you have expertise in auto repair. Is that a viable possibility?
EXPLANATION OF LOW STAKES WRITING: ONE PARAGRAPH OF THE INSTRUCTION PAPER for Friday, Apr. 24, 2020
By "paragraph," I mean that you should write either the paragraph of introduction, which is rather brief
OR
one full step in the 4 or 5 step process.
I will be looking for clarity and specificity of language.
for Monday, Apr. 27, 2020
TF comments are in bold, but I welcome your comments in the comments section:
During this time of quarantine, it's important to stay sane and realize that this pandemic may be prolonged and what better way to maintain sanity than to keep busy. This is a great opportunity to learn something new. This homemade lightbulb experiment is not only simple and fun but allows you to be creative due to its malleability. You only need [With] simple ingredients: [We don't need to use a sentence fragment.] a [A] pack of batteries,two clear different sized cups(large and small),two copper wires with 4 small alligator clips, lead, tape.
The Set Up
1.tape all of your batteries from your pack (fair amount [This expression could be confusing; just say 2-4) 2-4) together ensuring that the opposite forces are stuck to each other (+/-)
2.will [You don't need will--which signifies the future tense; all of the verbs should be parallel in structure] grab one end of one copper wire and tape it to the bottom of the small cup facing up. Then do the same with the other copper wire and tape it across the first wire.
3.Obtaining lead is quite simple as it can be found in any automatic or plain pencil. (Graphite will work just fine.) [Use periods to end all sentences.] The thinner the more effective. You will clip it on the stand you just created in step two, ensuring each clip is assigned to one end of the lead. [The first two sentences should be AFTER the actual instruction: Clip the lead on the stand....]
4.Place the larger cup over your initial contraption, ensuring that the free ends (non taped) of the copper wire are outside.
5. Just [You don't need the preposition: by] placing (toughing) [I think you mean: touching] one end of copper wire to the positive end and the other one to the negative will allow the electrons from the batteries to flow through the wire into the lead and heat it up, creating a glow effect mimicking a light.
***********
How To Use A Butt Splice Connector
A butt splice connector is an accessory used to create a seamless electrical connection between two wires. This accessory is inexpensive, safe, effective, quick to apply and very easy to use, making it a desirable appliance for both professionals and hobbyists. The items that you will need are: the butt splice connector, wires, wire strippers, wire crimpers, and goggles for safety.
(Photos of all the tools will be placed here)
[This is a very clear, concise, precise account of the purpose of this connector and items used; it is very suitable for an introduction. There are no grammatical issues.]
************
Please note: Keep saved files only AND Remove all are bolded by the writer; I have done other bolding:
Step 2: Launch the tool [You need to mention what the tool is in step 1; you probably know that you can alternate between the name and "the tool," but I'm just saying it for everyone's benefit.] and select any one option from the prompt on your screen. Choose the option Keep saved files only to keep all personal files -or- choose the Remove all option to delete all files. [In this case, bulletin points for these 2 items would be easiest to read. If other class members disagree with me on this, speak up.] (Warning: In any case, this tool will perform a complete re-installation which will remove all manually installed applications in order to install new built-in apps. [This sentence is a little challenging for some average readers. I don't think the phrase "In any case" is necessary, but also you should put "will remove... applications" first and then the part about re-installation; This tool will remove all ... built-in apps, This will be a complete re-installation.] It will reset all personalized settings and change to default settings which may affect the overall performance of your device) [Do you want to tell them HOW it will affect the overall performance? Would that be helpful?]
************
To watch my video on the Instruction Paper, please click on this link:
https://youtu.be/jtNSWG8tYEI
I am inclined not to post a sample set of instructions, as I promised to do on the course schedule, because there are so many differences in products that any 1 or 2 examples of the Instruction Paper could not cover the whole range.
During this time of isolation for some of us, and a time when those of us who have to leave home to go to work don't have time to do homework when they're on the job, it's best to look around your home for the subject matter of the Instruction Paper, which is longer, more involved, and more technical than what you've done so far. Your paper might deal with installation, use, or repair of:
computer software
" hardware
involving a:
desktop
laptop or tablet
I-phone
robot
If you're going to be an engineer involved in household product development, think about a:
TV
CD player
toaster oven
radio
microwave
washing machine dryer
Some of you have expertise in auto repair. Is that a viable possibility?
EXPLANATION OF LOW STAKES WRITING: ONE PARAGRAPH OF THE INSTRUCTION PAPER for Friday, Apr. 24, 2020
By "paragraph," I mean that you should write either the paragraph of introduction, which is rather brief
OR
one full step in the 4 or 5 step process.
I will be looking for clarity and specificity of language.
for Monday, Apr. 27, 2020
USABILITY TEST
Did you or someone you know ever follow a set of technical instructions and get frustrated because the job took too long to complete? Did you or the other person feel that the instructions were not clear or well expressed? The usability test is supposed to measure the effectiveness of a set of instructions.
In a professional situation, your company would carry out the test with five or more users, and if problems were found with the instructions, the revision would also undergo the same testing with five more users, and so on. If you are living with other people and want to perform a test to measure the effectiveness of what you have written in the Instruction Paper for an item that you have at home, you might learn something, even though you don’t have a large enough statistical sampling. Then again, you can test any set of instructions for a product in your home that you think might be improved.
Procedure for Usability Test:
1. In the instructions that you would test, there should be between 4 and 8 steps for the reader to do to perform the overall task.
2. Decide in advance the dividing line between a successful or unsuccessful attempt at doing the task. This would include the maximum number of errors made along the way, and the overall result during the time limit.
3. Present the instructions to the reader. Explain the procedure of the test, but do not give any explanation about the instructions themselves. The reader should get 10 minutes to fulfill the task.
4. Observe the reader of the instructions as s/he tries to perform each phase of the task. Write down:
· the time it takes to do each step of the task
· the overall time taken to do (or give up trying to do) the whole task
· the achievement or lack of achievement of each step in the task
· the achievement or lack of achievement of the whole task
· their comments about problems they find with the instructions.
5. When you write up your description of what you observed on the basis of notes you took and then write your evaluation of the relative success of the instruction paper based on your criteria, you will see if anything needs to be written different, and you can specify what changes seem logical to implement.
As you mentioned in the video, the difference between an instruction manual and instruction paper is the size of the document where the instruction paper is a few pages smaller than the manual. In my experience, I have seen that the step-by-step instructions in a manual include a lot of details on each step. Does this mean that the step-by-step instructions on the paper will have to be summarized into shorter sentences or sections?
ReplyDeleteRochelle, it's very important that I don't burden you all with an extremely long assignment; I think that you should pick instructions that comprise one phase of operations and not a whole manual worth. For example, it could be assembling something, adding an app, doing a maintenance procedure, or cleaning the appliance, disassembling and then making the product ready for recycling--but not all of these together.
DeleteI didn't totally answer your question; I only implied the answer. You don't have to summarize the instructions into short sentences or sections; you should pick something that has fewer steps so that you can still have a lot of details on each step, if necessary.
DeleteWhen we would mostly make us of a paper like this would be if We as an engineers would make a change to a product and then what we would have to do is explain how this change would work and how this item will be used - Ever Flores
ReplyDeleteOK, Ever, that's interesting. Could you give an example of a particular product and the kind of change you would be making?
DeleteI am going to change the topic for only 1 minute, and then we should return to the Instruction Paper brainstorming. For those of you who are having difficulty with grammar and proofreading, I have received the follow email from the Co-Director of LaGuardia's Writing Center, and I have posted it on the "Grammar" section of this blog, but I'll copy and paste it here:
ReplyDeleteDear Colleagues:
Greetings from The Writing Center Hub! I hope this email finds you well. I wanted to inform you that I opted to produce Powerpoint tutorials for students as an alternative to the in person workshops initially promised. This may be more useful since students can view at their leisure. Please share the links listed below with students.
Integrating Sources:
https://youtu.be/2-bQZReXxXY
Subject Verb Agreement
https://youtu.be/hdMggIE8FaE
Sentence Structure
https://youtu.be/0I07rLcPsVM
Thanks,
r
I'm not knowledgeable about this, but don't engineers have some part in making a new model of an I-phone come on the market? And don't those I-phones have complex new features that people need instructions to figure out?
ReplyDeleteFurthermore, let's talk about the stereotype--which can't exactly be trusted because Bill Gates, to cite only one example, is in his mid sixties-- of how frustrated millennials and post-millennials get with baby boomer grandparents and how frustrated those grandparents get with the technology? Could one answer be better instruction papers (and of course manuals)?!!!
Referring to the usability test the most common form of a set of instructions is a manual for example a manual for a dining table?
ReplyDelete-Ever Flores
Ever, remember that we're not actually doing a usability test. A manual for a dining table would be an example--yes.
DeleteFor the instruction manual task could a recipe serve as an example or is it to irrelevant to the subject
ReplyDeleteA recipe is an instruction paper, Wilson, but it's irrelevant to what we need to focus on in a Technical Writing class. That's why I mentioned thinking about I-phone instructions.
DeleteFor some possible ideas for people to use, writing an instruction paper on how to create some simple codes or how to use a certain function in a programming language can be a possibility. Another one is how to use basic functions in a CAD program such as sizing tools or maybe how to make simple shapes or a gear. For more of the hardware side, writing about how to properly strip wires and connect them to each other or how to properly solder them to a board are also good ideas.
ReplyDeleteFor the low stakes writing assignment, it says to write a paragraph. I'm assuming that this is the intro or can you jump to the step-by-step instruction part? Chronologically, writing the intro makes more sense but maybe doing the instruction part first will make it easier to do the other components?
-Chun-Hang Li
Chun-Hang, you have SEVERAL GREAT ideas for the Instruction Paper; everyone should pay attention to what he's saying in the first paragraph!
DeleteYes, in various writing tasks, many people find it better to start in the middle and go to the end so that you know how to introduce the topic properly. The 19th century German idealist philosopher Hegel wrote in the preface of a very long and complex book how he was writing the preface last for this very reason. That being said, others find it important to begin with the introduction. It's your choice. The important thing is to do some part of the paper and get feedback from me and perhaps other students.
On the main part of this blogpost, I have just posted a clarification of the low stakes writing task for this Friday on the basis of Chun-Hang's question.
ReplyDeleteCan i write about new tech gadgets instead of microwave computer etc. I want to audience interested in reading.
ReplyDeleteYes, Aydin, that sounds exciting! But make sure to be very clear about how to use whatever gadget you choose when you write the instructions
ReplyDeleteI think I'm going to go ahead and not involve something I that would relate in my field to get more uncomfortable with being comfortable with writing an instruction manual. That should be informative and not too lengthy.
ReplyDeleteI understand your point, Joshua. Close to two pages double spaced, but also including any graphics, if necessary, is a good length.
DeleteIs the instruction paper will be like an informative part, for instance if I bought a chair and i have to build it on my own, is the instruction paper is kind of like the paper that will lead me on every steps?
ReplyDeleteYes, Christie, that's exactly what the instruction paper is.
DeleteSince, I am majoring in civil engineering, can my instruction paper about how to build a bridge in carton?
ReplyDeleteI started it but I want to make sure that I am in the right path.
Yes, Christie. That's fine.
ReplyDeleteAfter making a brief introduction to our papers and to continue with the the paper for the tools necessary is it acceptable to list them as bullet point or would they go together in the introduction of the paragraph
ReplyDelete-Ever Flores Hernandez
Bullet points could work. Try it, and if it seems to be overwhelming for the reader, switch to paragraphs, but if it seems easy for the reader, keep it.
DeleteCan we use pictures in each step to guide the user?
ReplyDelete-Chun-Hang Li
Chun-Hang, yes, picture can be used in each step or not. See what works best.
DeleteCan we give the final picture of how it should look like in the conclusion?
ReplyDeleteChristie, that is probably a good idea, but again, use your judgment as to whether it's necessary.
DeleteI'm going to be writing my comments on the sample low stakes on the blog post itself, but please feel free to make comments here.
ReplyDeleteAnd you can make comments up until the next class.
DeleteBy the way, I'm realizing that when I set aside time for grammar issues, no one has questions. Well, that's ok, but for those of you who have quite a few grammar errors in your low and high stakes assignments, I strongly recommend that you get Grammarly online, and if you have time, please either go to the LaGuardia Writing Center website (find on Google) or study particular grammar issues on the Purdue OWL website by googling such searches as "run-on" "Purdue OWL."
For the step-by-step instructions I noticed the textbook suggests writing in a command form (imperative mood) avoiding pronouns and the passive voice, is it alright to use the word "individual" in the instructions when referring to one of two participants following the instructions? Or should the instructions purely be in command form.
ReplyDeleteYes, Jose, "individual" is ok in the way I believe you used it in your low stakes passage. Instructions should be mostly but perhaps not always in command form.
DeleteIn the textbook, it mentions how we should not include a feedback statement in the step-by-step instruction section. In that case, would it be okay to include when writing a warning or caution?
ReplyDeleteMaybe, Rochelle. Could you give an example?
DeleteNo, it doesn't say not to give a feedback (effect) statement; it says not to separate it from the section that the cause (action) part is in.
DeleteOkay, that makes sense. So, for example, "Step 2: Select the option: Launch the tool.(Warning: Selecting this option will cause the system to reboot which will delete all open files.)" would be acceptable?
DeleteYes, it would be fine.
DeleteIn my time sequence for today, I probably allotted too much time for the Usability Test, since you won't actually be doing it in this course. And it's really too bad that this assignment is a victim of the current move online because of the crisis: engineers are really good at following technical directions, and because of that, many of them might not be sensitive to how other people aren't and how some people are just downright bad at it. The Instruction Paper and the Usability Test are the parts of this Technical Writing course that emphasize clear, precise communication across groups of people with different scientific and competency levels, and it is something needed a great deal in our world today to solve the massive problems that we face. I am encouraged by some of the low stakes writings that I saw and also by a (high stakes) Instruction Paper that was handed in (and given a high grade) ahead of time, because you are making an effort to be as clear as possible.
ReplyDeleteAnyway, the time sequences each class day are very flexible, but if there aren't questions about the Instruction Paper that is due this Friday, I'm very willing just to go over to the Recommendation Report post and focus on that. This is listed as beginning in an hour (3:25).
I will shuttle between this post and that one, as well as my email. of course, until we finish at 4:15.
To create a successful Usability test, the Instruction Paper has to be clear and concise and explain everything. For example, though you or your peers may have an understanding of a certain tool, explaining how to use it or the markings on it may be required for someone that is not familiar with the tool.
ReplyDeleteIf we were to actually perform the Usability Test, observing where mistakes are happening repeatedly among multiple people is a big sign that you will need to rewrite that part of the Instruction Paper.
As for timing, conduct the Usability Test yourself to see how long it takes. Most of your peers should be able to complete it in about the same time as yourself. People unfamiliar with it will take longer, but if it's a ridiculously long time, you know that your Instruction Paper is not friendly with those that do not know anything about it.
-Chun-Hang Li
I totally agree with everything Chun-Hang is saying.
DeleteRegarding the Instruction Paper, I find it interesting that none of you so far have chosen to write them about desktop, laptop, or I-phone operations. Maybe you're overloaded with this kind of technology and just want to think about something else!
Please note that some of you have posted interesting comments on the Instruction Paper in the Recommendation Report comments section.
ReplyDelete