Name of each stepFor readers who already know how to do the procedure up to a certain pointExplanation of each step (illustrated as necessary)Key ConsiderationsPlanning:AudienceFirst thing to identify: Who am I writing for? Who is my audience?What is their knowledge of this subject?Educational and Technical levelsWhat are their responsibilities in the organizationAdditional details or warnings to prevent s/o from getting in troubleContent expertsTechniciansDecision makers - need a strong argument and to show you have done your researchLay reader - various people from different backgrounds; translating message to a different audience; provide background information and definitions(Communication) Goals- what do you want your readers to do?Want reader(s) to understand your meaning exactly as you intend.Situation- Why are these instructions necessary?UseHow will instructions be used?Will readers need to read all before the task?What is the context of readers’ use?Does the reader need to read everything before they do it?ProblemsReaders could encounter while attempting to use instructionsRelated to safety and/or quality controlEmphasize? How much?Necessary warnings or notesBe thoroughTopics- Weed out necessary vs. optionalFormatConsider context, enhance accessibility, visualsCommon Format OptionsOnline, online to be printed, paper, manual, posterOutline - Meet readers’ needs? Achieve purpose?Active Research:Background- History and purpose of product or provesObservations- Watch people using product or doing processAsk the expertsUse your senses- Describe motion & changeCollect visuals- Consider setting(s)Document content:State purpose and importance of taskSignal a completion of the task:Describe the finished product (for reader comparisons)Offer troubleshooting adviceNot online assistance (when available)Design:Page layout- clear flow of direction for readersGraphics, illustrations, photographs, diagramsVisuals- Do they help the reader understand what is being explained?Revisions:User-test with sample audienceRevise for content, style and designMake sure instructions are clearly written and easy to followCheck text and visuals for accuracyProofread text for grammar, punctuation, etc.JTC 300 1nd Edition Lecture 7 Outline of Last Lecture I. Emails, E-Messaging, Texts, and Memosa. Common Reasons for Writing Emails, Letters, and Memosb. Quick Tips for Emails, Memos, and LettersII. AttachmentsIII. Choosing Between Email and Memosa. Memo ContentIV. Appropriate Tone in Email Letters and Memos Outline of Current Lecture V. Instructions vs. Procedures VI. Standard SectionsVII. Key Considerationsa. Planningb. Active researchc. Document Contentd. Signal a Completion of the Taske. DesignVIII. RevisionsCurrent Lecture Instructions vs. Procedures- Instructions describe how to do a specific tasko May be necessary for readers who need detailed directions to perform a task or profess o Micro- Procedures/ Protocols are general guidelineso Describe consistent methods and procedures to be followedo MacroStandard SectionsThese notes represent a detailed interpretation of the professor’s lecture. GradeBuddy is best used as a supplement to your own notes, not as a substitute.- Introduction- Theory behind the procedure or instruction- Warnings, cautions, hazards & notes about safety or quality (illustratedas necessary)o Make them “pop” e.g. red, bold, ALL CAPS, etc.- Conditions under which task will be performed- Name of each stepo For readers who already know how to do the procedure up to a certain point- Explanation of each step (illustrated as necessary)Key Considerations Planning:Audience- First thing to identify: Who am I writing for? Who is my audience?- What is their knowledge of this subject?o Educational and Technical levels- What are their responsibilities in the organization- Additional details or warnings to prevent s/o from getting in troubleContent experts-Technicians- Decision makers - need a strong argument and to show you have done your research- Lay reader - various people from different backgrounds; translating message to a different audience; provide background information and definitions(Communication) Goals- what do you want your readers to do?- Want reader(s) to understand your meaning exactly as you intend.Situation- Why are these instructions necessary?Use - How will instructions be used?- Will readers need to read all before the task?- What is the context of readers’ use?o Does the reader need to read everything before they do it?Problems- Readers could encounter while attempting to use instructions- Related to safety and/or quality controlo Emphasize? How much?- Necessary warnings or noteso Be thoroughTopics- Weed out necessary vs. optionalFormat- Consider context, enhance accessibility, visuals- Common Format Optionso Online, online to be printed, paper, manual, posterOutline - Meet readers’ needs? Achieve purpose?Active Research:- Background- History and purpose of product or proves- Observations- Watch people using product or doing process- Ask the experts- Use your senses- Describe motion & change- Collect visuals- Consider setting(s)Document content:- State purpose and importance of taskSignal a completion of the task:- Describe the finished product (for reader comparisons)- Offer troubleshooting advice- Not online assistance (when available)Design:- Page layout- clear flow of direction for readers- Graphics, illustrations, photographs, diagrams- Visuals- Do they help the reader understand what is being explained?Revisions:- User-test with sample audience- Revise for content, style and design- Make sure instructions are clearly written and easy to follow- Check text and visuals for accuracy - Proofread text for grammar, punctuation,
View Full Document