schedule*
| date | agenda, prep, work due today |
| (wk1) Tu Sept 6 | intro to the course: policies, index cards, introductions, course materials (UDrive) note: I emailed out a link to our course UDrive; if you did not get the email, let me know |
| Unit I: Introduction to Software Documentation—Instructions and Screenshots | |
| (wk1) Th Sept 8 | writing instructions, considering audience today's prep**: - read the first 10 pages of Instructions, Procedures ... (UDrive, 221-331) - read Jerz, How to Write Guides for Busy, Grouchy People - complete practice recipe exercise reading questions: What will you want to know about your readers in order to make your documentation more usable? What are the 8 guidelines for instruction-writing recommended in the reading? How does the format or organization of your instructions affect readers' ability to interpret and use them? concepts (in class): tacit knowledge, SME -------------- **The tasks listed for each class meeting under "today's prep" should be completed in time for that day's class; this applies to all class meetings on the schedule. |
| (wk2) Tu Sept 13 | screenshots, introduce assignment #1 today's prep: - read Screenshots (UDrive) - create a practice screenshot on a PC - insert and crop your screenshot in Word - create a callout and a caption in Word reading questions: What is software documentation? What are some of the benefits and limitations of using screenshots? How can you create a stronger connection between a screenshot and the text to which it corresponds? concepts (in class): stem sentences, imperative/active voice, parallel structure |
| (wk2) Th Sept 15 | screenshots, workshop assignment #1 today's prep: - bring complete draft of instructions assignment #1 to workshop (2-3 copies) concepts: actions/results, present tense, elaboration, writing w/ users in mind -------------- links of interest: Jing: free screen capture software, allows you to easily create custom screenshots Webopedia: a free dictionary of words, phrases and abbreviations that are related to computer and Internet technology |
| (wk3) M Sept 19 | |
| (wk3) Tu Sept 20 ASSIGN #1 DUE (SCREENSHOTS) |
user analysis, introduce Word manual today's prep: - read Barker Ch 5, "Analyzing Your Users" (118-129, 140-141) - due: submit hard copy of assignment #1 (no transmittal memo/letter for this) reading questions: Why conduct a user analysis? What are some strategies for conducting a user analysis? in class: discuss Word manual assignment, begin user analysis |
| Unit II: Planning the Documentation Project—User Analysis, Doc Plans, and Modular Design | |
| (wk3) Th Sept 22 | user analysis, task orientation, drafting your TOC today's prep: - read Barker Preface and Ch 1, "Understanding Task Orientation" (1-22) - print and bring Writing Transmittal Letters handout to class - reading questions: What is task-oriented documentation? What are some features of docs that are *not* task oriented? Try to think of examples of tasks that could be relevant for your Word manual. How can thinking about tasks help you plan the organization of your manual? |
| (wk4) Tu Sept 27 | modularity today's prep: - read selections on modular documentation (UDrive) and Barker (361-363) - read through the doc plan handout (assignment #2) - recommended: begin drafting your TOC (see Barker 185-186 for examples) user research memo: Your user research memo is due on Thursday, along with a draft of your TOC (table of contents). Your user research memo should summarize the process (who you interviewed, how you prepared and conducted the interview), and most importantly the key findings from the interview process (what did you learn about tasks, motivations, software use, and so on). reading questions: What is modular documentation? What are its features? What are its benefits and limitations? |
| (wk4) Th Sept 29 | doc plans today's prep: - read "What's a doc plan?" (UDrive: pp. 36-39; 263-269)* - draft of TOC due for workshop - bring print copy of your user analysis (word-processed) *note: I've divided the readings on doc plans between today and Tues, Oct 5, but you are welcome to read or skim ahead as you draft your TOC -- in particular, Barker's discussion of TOCs on pp. 184-186 should prove helpful. |
| (wk5) Tu Oct 4 |
Visio today's prep: - Barker Ch 6, "Planning ..." (174-178, 184-186, 191-192, 196-197, 207-213) - draft of doc plan* due (short workshop); be sure to have your schedule section (see below) in class: you will use Visio to create a chart for your doc plan. You will need access to a copy of your doc plan's project schedule for this exercise. recommended: read “Ten Things Every Microsoft Word User Should Know” *note: scroll down to the "assignments" section at the bottom of this page for links to the doc plan assignment sheet and a handout with formatting tips |
| (wk5) Th Oct 6 ASSIGN #2 DUE (DOC PLAN) |
writing to teach; the good, the bad, and the ugly today's prep: - read Barker Ch 2, "Writing to Teach—Tutorials" (30-54) - due: submit your completed doc plan (including Visio chart) + transmittal memo reading questions: Which ideas in this chapter seem relevant or helpful for thinking about your Word manual, and why? Of the types of tutorials described in the chapter, which have you encountered? Where? What are the features of the "Quick Start" and how does this type differ from the others? What are some "typical-use scenarios" for users of your Word manual, and how might these influence the organization and structure of the manual? How do elaborative and minimalist approaches differ, and what is the rationale for each approach? in class: if there's time, you'll get your assignments for the Word challenge demo (assign #4) -------------- links of possible interest: student discount on Office 2010 Microsoft free 60-day trial of Office 2010 |
| (wk6) M Oct 10 | no class - Columbus Day |
| (wk6) Tu Oct 11 | no class - treat as a Monday |
| (wk6) Th Oct 13 | writing prodedures, drafting your modules today's prep: - read Barker Ch 3, "Writing to Guide—Procedures" (63-87, esp. 63-73 and 80-87) - bring 2 modules (print copy + digital file) reading questions: What is a rhythm (or pattern) of exposition, and why is it important? What does Barker present as the Standard Format, and what features does it commonly include? What are its advantages and disadvantages? What's a hanging indent? |
| (wk7) Tu Oct 18 |
drafting the first third today's prep: - continue drafting modules for your first third; bring your digital Word files to class - read Barker Ch 12, "Getting the Language Right" and Microsoft Manual of Style, “Punctuation” (171-182, esp. quotation marks, apostrophes, hyphens, and ellipses) reading questions: What en dashes and em dashes? When are they used? How are they different from hypens? |
| (wk7) Th Oct 20 | drafting the first third, Word demos (assignment #4) begin today's prep: - continue drafting modules for your first third - begin thinking ahead to user testing in week 10 Word Challenge groups: Demo #1 - Team Wingdings: Dan, Emma, Shevonne, Diego (Th, Oct 27) Demo #2 - Team Garamond: Allison, Rike, Anna, Ash M. (Tu, Nov 1) Demo #3 - Team Trajan: Robin, Ismail, Ashley C. (Tu, Nov 1) Demo #4 - Team Papyrus: Karina, Kat, Kevin (Th, Nov 3) Demo #5 - Team Helvetica: Victoria, Melissa, Peter (Tu, Nov 8) Demo #6 - Team Futura: Kirstyn, Garrett, Alex (Th, Nov 10) |
| (wk8) Tu Oct 25 ASSIGN #3 DUE (1ST THIRD) |
drafting the first third, Word demos today's prep: - first third of Word manual + transmittal memo due mid-semester check-in arrange to see me if you have questions/concerns about your performance in the course |
| Unit 4: Visual Signposts: Page Design, Typography, and Visual Hierarchy | |
| (wk8) Th Oct 27 | drafting the first third, Word demo #1 Demo #1 - Team Wingdings: Dan, Emma, Shevonne, Diego (Customizing Word) . . . . . today's prep: - read Edward Tufte, "Smallest Effective Difference" from Visual Explanations - begin drafting modules for your second third questions: What does Tufte mean by "smallest effective difference"? How might this concept be applied to the work we're doing in 380? . . . . . recommended: read Edward Tufte, "Layering and Separation" from Envisioning Information |
| (wk9) Tu Nov 1 |
drafting the first third, Word demos, page layout Demo #2 - Team Garamond: Allison, Rike, Anna, Ash M. (Facing pages) Demo #3 - Team Trajan: Robin, Ismail, Ashley C. (Page numbering and orientation) . . . . . today's prep: - read about page layout (UDrive) reading questions + concepts: What is visual hierarchy, and what are some of the ways you can communicate information hierachy through your design choices? Explain the concept of "negative space" and its application to the page design of your Word manual. Consider the following concepts as they apply to your current page design: alignment, contrast, enclosure, proximity, power zones. What connections or contradictions do you see between the Tufte readings and today's reading on page layout? . . . . . strongly encouraged: read Edward Tufte, "Layering and Separation" in Envisioning Information (if you're short on time, look at the before-and-after illustrations and skim the explanations). What does Tufte mean by "1+1 = 3"? |
| (wk9) Th Nov 3 | typography, drafting the second third Demo #4 - Team Papyrus: Karina, Kat, Kevin (Running headers and footers) . . . . . today's prep: - read about typography (UDrive) - reassess the page design of your modules - revise one module and bring it to class (digital is ok) concepts: serif vs. sans serif, leading, kerning, justification, rivers, crystal goblet |
| (wk10) Tu Nov 8 | workshop, drafting the second third Demo #5 - Team Helvetica: Victoria, Melissa, Peter (Applying styles) . . . . . today's prep: - bring drafted content for your second third to class*; print at least one module in color - bring any files you need to work on your draft in the lab *note: It's not necessary that you have the entire second third ready to workshop (though the more you can get done, the better shape you'll be in). My suggestion would be to get as much content created as possible (steps drafted, screenshots), and then focus on the layout of a couple of modules that you can bring to workshop for feedback. |
| Unit 5: User Testing | |
| (wk10) Th Nov 10 |
drafting the second third, user testing Demo #6 - Team Futura: Kirstyn, Garrett, Alex (Troubleshooting lost data) . . . . . prep: bring any files you need to work on your draft in the lab |
| (wk10) Fri Nov 11 | Veterans' Day -- no classes |
| (wk11) Tu Nov 15 ASSIGN #5 DUE (2ND THIRD) |
user testing due today: submit second third of your Word manual—must be printed in color, transmittal memo concepts (in class): user testing, paper prototypes |
| (wk11) Th Nov 17 | user testing today's prep: - read Document Usability (UDrive) - bring drafts of your scenarios (as discussed in class) and your rough plan for your user test . . . . . Recommended: Steve Krug's Don't Make Me Think!) - How to do your own testing - Sample testing script (for testing websites) |
| (wk12) Tu Nov 22 | user testing today's prep: - complete user testing of your manual with 2-3 users - bring memo* reporting results of your testing (I will collect the memos) - bring files -- we will likely spend some time in the lab today . . . . . *memo details Write up your test findings in a memo addressed to me (1-2 pp). The memo should: 1) explain your test objectives and test design 2) describe your test participants 3) report your findings 4) reflect on the testing process itself |
| (wk12) W Nov 23 | Thanksgiving recess begins after last class |
| (wk12) Th Nov 24 | Thanksgiving holiday |
| (wk13) Tu Nov 29 FINAL THIRD DUE |
final third due today Submit electronic draft of final third, via email, by 10:00pm (jlsolber@english.umass.edu). This third will not receive feedback, but completion will be recorded in the gradebook. check out the blog entry “14 Widespread Myths about Technical Writing” |
| (wk13) Th Dec 1 | printing, binding; writing the introduction today's prep: - read about print production (UDrive) - finalize your printing plan (see note below) - bring the files for your manual draft In preparation for printing your manual: Do some research to decide how and where you will print and bind your manual. Contact local print shops for information on turnaround time, file formats, bindings, prices, hours of operation, and so on. If you plan to use your own color printer, make sure you have enough paper and ink to print your entire manual at high quality, and make sure the paper you plan to use will take the ink without smudging. musical interlude |
| (wk14) Tu Dec 6 | writing the introduction today's prep: - bring drafts of your introduction - make sure you have drafted all required elements of the manual (see handout) - bring your Word manual files Your manual should now be completely drafted, and you should be polishing, fine-tuning, and proofreading at this point -- as well as pulling together your final supporting documents. By now, you should also have determined how you will print and bind your manual, as well as contacted print shops for information on hours of operation, turnaround time, file formats, prices, bindings, and so on. Allow ample time for printing and binding. Assume that printing will take longer than you expect, and that something will probably go wrong. |
| (wk14) Th Dec 8 ASSIGN #6 DUE (COMPLETE WORD GUIDE + SUPPORTING DOCS) |
submit Word manual (as hard copy *and* email a PDF version) and supporting documentation (as discussed in class) |
| Have a safe and happy holiday break! |
|
| (wk14) F Dec 9 -- last day of UMass classes | |
| (wk16) Dec 10-11 -- reading period | |
| (wk16) Dec 12-17 -- final exams | |
* THE FINE PRINT I reserve the right to make changes to the schedule, as needed, to accommodate the needs and pace of the class. |
|