February 7th: Planning For Your User Documents

An Article for Valentine's Day

Folks, it's scientifically proven that it just gets worse...

Let the Funner* Times Begin

Below is a list of what we'll attempt to get to today. I'll give you a preview now:

• Finish IRA-Career Discussion

• Computer Programming Language History (maybe)

• The Future of Tech Writing and the IT World

• Inspiration in User Docs?

• 101 Ch. 1 & 2 Highlights

• Interactive Design vs. Usability Testing

• Planning User Doc #1

• IRA-Career Essays (turn them in before you leave)

We want to have 30 minutes or so at the end of class to develop a plan for User Doc #1. I know you can do it! Can you hear the drums Fernando? Huh...can you? Well, I can!

The Future of Tech Writing

Last week I prophesied (to some of you) the demise of the technical writing profession in its traditional, engineering-centered standard. If you didn't hear that, well, I'm telling you now. I don't believe the profession is going away completely, but I forsee a split in future technical writer identities:

1) the information designer (manager, place in the IT lifecycle)

2) the copyeditor (contractual, temporary, LIFO)

Based on my own observations, I've come to this conclusion. Am I right? I don't know. Do I have the final say? Absolutely not. This is a discussion that should take place, and I hope it prompts research (institutional and individual) and thinking. Professionals, teachers, and students ought to engage in discussions about the field's future. If anything, social and political changes (economic falls under social, by the way) will most likely alter all "work" in the future, and technical communication isn't exempt from change. But what changes? We won't know until after they happen, but we (in the larger sense, not just in class) can still make predictions, defend/refine those predictions, and prepare 21st-century citizens. Otherwise, we risk indoctrinating 21st-century workers with 20th-century workplace ideology that ignores our information-oriented economic base.

Therefore, I see discussions of work as necessary to our class. Now, I know many of you aren't taking this course to become technical writers, but the career issues we bring up will be important for your understanding of workplace environments. Most of our discussions will be general, but they ought to focus on social forces that permeate through society, which you should consider a collection of (sub) cultures as opposed to a culture.

I put together a webpage that lists jobs and job descriptions in technical writing. Most are in IT companies, but some are in other areas. This selection was just a google search (done a while ago), so I have no statistical basis for claiming that it is representative of the total population of technical writing jobs. However, based on my observations over the last decade, I think two jobs stand out as exemplary Tech Writing jobs:

Consider opening these in different tabs, so you can more easily compare them.

• The tech writer in an IT firm (a "model" future job description)
• The tech writer in a consulting firm

The entire list is here, and I have another shorter page here. I hope to add to these in the future. Notice the contractual/temporary vs salaried/permanent positions. Also, notice the skills required for the positions. The list is for reference and class discussion, so don't worry about job details showing up on an exam or quiz.

Inspiration in User Documents

I've been continuing to think about inspiration in technical communication. Do we ever inspire users to try to tackle instructions for a tool, system, or process? I don't think we always can (or should), but I'm  suggesting you should try to inspire your users to want to learn more about the interface, instrument, or whatever it is you're attempting to document. Is it possible? I'm curious to see what you come up with. However, don't fixate on that because we'll go into more detail in the next couple classes. Frankly, it's hard to inspire with a search engine...or is it. Don't forget to consider personas vs. users.

Technical Writing 101: Chapters 1 & 2

Did anyone notice a difference between Cooper and today's reading? Technical Writing 101 is a field-specific guide for technical writers, but it's useful for all of you who will do some form of technical communicating in the future. Cooper's book is aimed at designers and business people in IT.

Chapter 1 Highlights:

Most of Chapter 1 is introductory, but it does bring up some key ideas for having a critical understanding of literacy and technological literacy. The first three bullet points are not in the chapter, but understanding them will help us have a vocabulary for thinking about technologies as social products with which humans interact.

• Critical Literacy: knowing how writing style effects your message and your receivers' attitudes
• Technological Awareness vs. Technological Literacy
  • Technological Literacy--knowing how to use technologies
  • Technological Awareness--knowing that technologies can be used for specific goals but not necessarily knowing how to use the technologies to carry out those goals
• Critical Technological Awareness: Being critically aware of technology means looking beyond a socially constructed artifact’s assumed practical benefit and critiquing its effects and development
• The various jobs of a technical writer: writer, manager, detective, QA/QC, and creative thinker

Chapter 2 Highlights:

• pp. 37-39: The typical view of a technical writer's process
• Knowing the culture of the workplace
  • Guidelines vs. practices
  • Standardizing the organization's language: a practice in ethnographic research
  • Audience expectations: clients, supervisors, co-workers, the public, partners, etc.
• Single Sourcing: Like WORMS-Write Once Read Many
  • Canned processes that can be used over again
  • User guides that let users figure out which release, model, or version they have
  • What's your organization's structure?

Interactive Design vs. Usability Testing

There's an interesting assignment that comes from a previous textbook I used for this class on paper prototyping:

Exercise: Working in groups, create a "paper" prototype for an information kiosk to assist visitors to your campus or office building or to a shopping mall or museum. The kiosk will be located in the lobby or central location (you define where). Visitors unfamiliar with the services or locations of departments would consult this kiosk to get a sense of where to go and how to get there. Consider the types of visitors you need to help and the types of information they will want. Create a profile of your primary visitors and tasks. Then, create the "interface," beginning with the main screen, from which the user can select other screens for information. When the task is complete, a representative from another group will become the target user for you kiosk to test the usability of your prototype. (Exercise comes from Barnum, 2002, p. 137)**

Instead of using index cards or paper, use the Notepad and have separate text files (.txt) represent different cards--using word documents would be goofy, so use Notepad. This ought to have a rather interesting effect on the user. When you come to the part where you bring in another user, describe (meaning write this down on something) how the user adjusts the prototype (the "cards") you created. Make sure you ask the user to arrange the cards on the desktop as they would want them to appear on a kiosk interface--don't coach them. Therefore, you create the cards, but let the user arrange them.

One of you should host the final prototype on his/her webpage, but each member should have a link to the prototype. Make screen captures or an entire screen capture of the layout the group decides.

Those of you who are testing these designs, I want you to report back to class why you arranged the cards or adjusted the contents of the cards (adding or deleting) the way you did. In other words, what is your mental model of how that particular kiosk should be set up?

Time permitting, I want to play a little memory game based on the short- and long-term memory but, if we're short on time tonight, we'll skip it.

Planning for User Doc #1

Please logon to Moodle and answer the following 1), 2), and 3) in the "Computer Literacy" discussion forum:

• On a scale of 1-10 (1 being least, 10 being greatest), rate your computer literacy.
• Why do you believe you are or are not "computer literate"? In other words, what skills or knowledge do you have or don't have that makes you claim you're computer literate or not.
• What is the your major/background?

I want you to turn to the person to your left and observe him or her doing the following:

• Find the web page for Vanderbilt University's nightly news footage repository.
• Type up a list of the news channels the repository holds.

Then, the person you observed should observe you do the following:

• Find out who won the Nobel prize in physics 102 years ago.
• Type up a list of the winners.

User Document #1

Assuming you're thinking about search engines, come up with a way to help a novice user "have fun with a purpose". You'll have a chance to test your classmates next class, so for the rest of class finish a rough draft for User Doc #1. Don't forget to include:

• A brief description of the instrument

• Explanation of how the user will approach the set of instructions

• A plan on how to test your draft (your document)

• Users or Personas?

These word-processed planning documents are part of your User Doc grade, so make sure you do them.

My First User Document

When you were reading Cooper's book, did you think about the frustrations you had with not only uploading a webpage but documenting that process? What parallels did you find? If you have some more time, let's try to perfect those user docs from a couple weeks ago.

Don't forget to have an updates page on your website that tracks changes. For today's update, add a link to your favorite search engine. This is a separate page from your 'index.html' page.

Before We Go...

Make sure you have a rough draft for your User Doc #1 next class. You'll be doing a user test on two of your classmates. Your draft for User Doc #1 should be turned in in two weeks (2/21).

*Discussion on Funner

What?!? Funner isn't a word. I mean, it's not in the dictionary...or is it. Click below for the scanned dictionary entries:

• Funner and Funnest

• Syllabuses

Words scanned from Merriam-Webster's Collegiate Dictionary. 10th ed. Springfield, MA: Merriam-Webster, 1999. p. 472 and p. 1194, respectively. In fact, this is one of the dictionaries used in the Writing and Resources Center.

How about concision instead of conscieness?

For an in-depth discussion on the "proper" usage of fun, check out World Wide Words or Grammar Girl's Discussion. Remember, when it comes to word usage, it's not who says it, it's who hears it.

**Barnum, Carol M. (2002). Usability Testing and Research. New York: Longman.