schedule
| date | agenda, prep, work due today |
| (wk1) Tu Sept 7 | introduction to the course: policies, index cards, introductions, online resources and accessing materials on our 380 course UDrive |
| Unit I: Introduction to Software Documentation—Instructions and Screenshots | |
| (wk1) Th Sept 9 | writing instructions, considering audience today's prep*: - read Instructions, Procedures ... (UDrive, pp. 221-231) - 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 14 | screenshots, introduce assignment #1 today's prep: - read Screenshots (UDrive) and "Preface" (Barker) - create a practice screenshot on a PC - crop a 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 -------------- optional software: pixlr, a free browser-based image editing program (and firefox plugin) |
| (wk2) Th Sept 16 | screenshots, workshop assignment #1 today's prep: - bring complete draft of instructions assignment #1 to workshop (3 copies) concepts: actions/results, present tense, elaboration, writing w/ users in mind -------------- links of interest: govconnection (UMass purchase program/portal) Microsoft 60-day trial of Office 2007 SnagIt 30-day trial |
| (wk3) M Sept 20 | note that today is last day to add or drop with no record |
| (wk3) Tu Sept 21 ASSIGN #1 DUE (SCREENSHOTS) |
user analysis, introduce Word manual today's prep: - read Barker Ch 5, "Analyzing Your Users" (118-129, 140-141) - print and bring Writing Transmittal Letters handout to class - due: submit hard copy of assignment #1 (no transmittal memo 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 23 | user analysis, task orientation, drafting your TOC today's prep: - read Barker Ch 1, "Understanding Task Orientation" (1-22) - bring print copy of your user analysis (word-processed) reading questions: What is task-oriented documentation? What are some features of docs that are *not* task oriented? Think of some 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 28 | modularity today's prep: - read selections on modular documentation (UDrive) and Barker (361-363) - read through the doc plan handout (assignment #2) - bring a working draft of your TOC (see Barker 185-186 for examples) reading questions: What is modular documentation? What are its features? What are its benefits and limitations? |
| (wk4) Th Sept 30 | doc plans today's prep: - read Barker Ch 6, "Planning ..." (174-178, 184-186, 191-192, 196-197, 207-213) - draft of doc plan due |
| (wk5) Tu Oct 5 ASSIGN #2 DUE (DOC PLAN) |
in-class activity, Visio due: submit final draft of your doc plan + transmittal memo recommended: read “Ten Things Every Microsoft Word User Should Know” (esp. 1, 2, 4) |
| (wk5) Th Oct 7 | writing to teach; the good, the bad, and the ugly today's prep: - read Barker Ch 2, "Writing to Teach—Tutorials" (30-54) - you should be drafting modules for your first third 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? |
| (wk6) M Oct 11 | no class - Columbus Day |
| (wk6) Tu Oct 12 | no class - treat as a Monday |
| (wk6) Th Oct 14 | 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 19 >> MAP |
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 21 | drafting the first third, Illustrator today's prep: - continue drafting modules for your first third in class: Illustrator |
| (wk8) Tu Oct 26 ASSIGN #3 DUE (1ST THIRD) |
Illustrator, cont. today's prep: - first third of Word manual + transmittal memo due - consider downloading a free 30-day trial version of Adobe Illustrator (optional) concepts: vectors and vector-based illustrations 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 Hierachy | |
| (wk8) Th Oct 28 | Illustrator; page layout, visual design today's prep: - read Edward Tufte, "Smallest Effective Difference" in 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? . . . . . strongly encouraged: 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) Tu Nov 2 ASSIGN #4 DUE (ILLUSTRATOR) |
Illustrator due, page layout today's prep: - read about page layout (UDrive) - finish your Illustrator assignment - due: Illustrator assignment, transmittal memo 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 overlap (or points of tension) 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 4 | typography, drafting the second third today's prep: - read about typography (UDrive) - revise the page design of your manual, taking into account in the visual principles discussed in class and our readings. Bring one module with the revised design to class (digital is fine). Post-class note: we didn't get to looking at your drafts tonight; we will make that up with workshopping and lab time on Tu, Nov 9 concepts: serif vs. sans serif, leading, kerning, justification, rivers, crystal goblet in class: Visit from Katie Barrell, Q&A . . . . . optional: read or skim Can neuroscience help Gap produce a better logo? (or The Science of Fail: Why the New Gap Logo Made Our Brains Angry) |
| (wk10) Tu Nov 9 | workshop, drafting the second third 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 in class: workshop; lab time to work on content *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 (text, 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) W Nov 10 N.B. Today follows a Thursday schedule. |
drafting the second third prep: bring any files you need to work on your draft in the lab in class: - visit from Kelsey Anderson, Q&A - if time, discuss some examples (compiled in PowerPoint) |
| (wk10) Th Nov 11 | Veterans' Day -- no class -- second third due TUESDAY (see below) |
| (wk11) Tu Nov 16 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 18 | 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 . . . . . You may find the following excerpts helpful (from Steve Krug's Don't Make Me Think!) - How to do your own testing - Sample testing script (for testing websites) |
| (wk12) Tu Nov 23 | 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 (arguably the most important section) 4) reflect on the testing process itself |
| (wk12) W Nov 24 | Thanksgiving recess begins after last class |
| (wk12) Th Nov 25 | Thanksgiving holiday |
| (wk13) Tu Nov 30 FINAL THIRD DUE |
final third due today submit electronic draft of final third + any specific questions via email, by 10:00pm (jlsolber@english.umass.edu) check out the blog entry “14 Widespread Myths about Technical Writing” |
| (wk13) Th Dec 2 | 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. |
| (wk14) Tu Dec 7 | 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 9 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 10 -- last day of UMass classes | |
| (wk16) Dec 11-12 -- reading period | |
| (wk16) Dec 13-18 -- final exams | |