Wednesday, Jan. 29

Exit Tickets

Helen

For project 2, would doing a non-electronic device like a brita water pitcher work?

Anabelle

One unresolved question is whether AI can generate images for Project 2.

Esperanza

What are some things we should be thinking about when we start planning our proposals? 

Project 2 (20)

Activity 2.1 -- due Sunday, Feb. 2

Markel and Selber, Writing Definitions, Descriptions, and Instructions (45)

Writing Descriptions (5) -- pp. 11-19

Descriptions are verbal and visual representations of physical or operational features of objects, mechanisms, and processes.

State in a title or heading the subject and indicate whether it is general or particular

Introduce the description (20.1)

• Provide appropriate detail; for objects/mechanisms, define each part and then describe its function, operating principle, and appearance; for processes, treat each step as if it were separate and explain what the step is, what the function is, when/where/how it occurs (and if the agent changes, announce it)

• Mechanism and object descriptions: Descriptions of natural and synthetic artifacts; mechanisms are synthetic objects composed of multiple parts.

• Choose an appropriate organizational principle (e.g., functional, spatial); use graphics

• Process descriptions: Descriptions of an activity that takes place over time

• Structure the step-by-step description chronologically, explain causal relationships among steps, use the present tense, use graphics, end with a conclusion

Activity (10)

Consider the examples below. Classify them as mechanism, object, or process descriptions. Which of these descriptions do you find most effective, given the guidelines that Markel and Seller provide? Which do you find less effective? Select 1 of the descriptions and some ways you might revise to adhere to Markel and Selber’s guidelines. 

Share your work with me on a Google Doc (it may be the same one you submitted for the last class session).

Description 1

https://i.pinimg.com/564x/84/bc/66/84bc661f901f49eddc2f1a83e3b7e2be.jpg

Description 2

https://images.squarespace-cdn.com/content/v1/572a5391e707eba7713cedf0/1504863117270-72HSSFJEG8VD0D4NIF11/Infographic_Processing+Methods+FINAL-01.png

Description 3

https://images.squarespace-cdn.com/content/v1/572a5391e707eba7713cedf0/1543549607663-G41NIVXON27LTGSWKLXK/Coffee_Plant_FAOL-01.jpg?format=2500w

Description 4

https://vinanhatrang.com/wp-content/uploads/2024/08/Coffee-Processing-Flow-Chart-3-scaled.jpg

Discussion (5)

Writing Instructions (10) -- pp. 20-40

Writing Instructions

Instructions are process descriptions that help users perform a task.

• Instructional videos 

  • • Can be useful for basic conceptual information, computer-based tasks, and technical tasks. 

    • Especially useful for things that rely on technique or subtle physical movements.

    • Should be brief (2-3 minutes; no more than 12-15)

Planning

• Consider modality. Should it be physical? 1 page? Should it be bound?

• Consider context. Reader expectations, abilities, if more than 1 set of instructions is necessary, what languages should be used, possible user anxieties, and the effect of environment.

• Planning for Safety

  • • Organization may be liable for putting users at risk if they are hurt

    • Avoid complicated sentences

    • Examples show a preference for imperative mood

    • Signal words: 

      • • Danger (for immediate and serious hazards that are likely to be be fatal; sometimes all-caps); 

        • Warning (potential serious injury, death, or damage; sometimes all-caps); 

        • Caution (potential for moderate injury or equipment damage); 

        • Note (tip or suggestion)

Drafting

• Titles. How-to (How to Brew using a Cafelat Robot); Gerund (Brewing with the Cafelat Robot)

• Introductions. Who should carry out the task? Why? When should it happen? What safety measures or other concerns should the reader understand? What items are needed? How long will the task take?

  • • Ex. Experienced homebrewers and curious espresso drinkers will love the low-maintenance, delicious espresso the Cafelat Robot can make. 

    • Estimated time. 3 minutes.

    • Items. 18g coffee; bowl, scale, grinder, portafilter, basket, boiling water, WDT, tamp, dispersion disc, espresso cup

    • Risks. Preheating the basket and portal; hot water can burn; piston mechanism needs to be operated properly or it can send boiling water spewing everywhere

• Steps

  • • Number them. 

    • If they are long and complex, divide into subsets. 

    • May benefit here from task analysis.

    • Include the right amount of information per step

    • Use imperative mood

    • Feedback statements should follow as an additional sentence in a numbered step. It is not its own numbered item.

    • Include graphics

    • Include articles (a, an, the) for clarity

Revise

• Revisions can be based on usability testing

Writing Manuals

• Typically longer than a set of instructions

• Typically contains multiple tests

• Typically contains additional sections: front matter, back matter, TOC

Activity (10)

Consider the examples on the handouts. What about these instructions do you find most effective, given the guidelines that Markel and Seller provide? Which do you find less effective? Focus on 1 set of instructions and identify 2-3 elements you think could possibly benefit from additional revision, based on Markel and Selber's guidance.

Share your work with me on a Google Doc (it may be the same one you submitted for the last class session).

Discussion (5)