Advanced Composition
English 202C - Technical Writing
Course Objectives
Sample Syllabus Materials
Sample Assignments
- Job Application Packet
- Technical Definition/Description
- Instructions
- Technical Report
- Progress Report
- Usability Memo
- Article Adaptation
- Collaborative Evaluation
- Procedural Instructions
- User Test Report
- Web Site Analysis
- Library-Internet Guide
Links
- Leonhard Center Technical Writing Initiative - Visit the Leonhard Center web site for more information on the Commissioned Assignment and Guest Speaker Programs.
- Leonhard Center for the Enhancement of Engineering Education
- Penn State Career Services
- Association of Teachers of Technical Writing
- Society for Technical Communication
- Technical Communication General Resources - A wealth of technical communication links from the DMOZ Open Directory Project.
Course Objectives
ENGL 202C, Technical Writing, serves students who are preparing for careers in the sciences and applied sciences (particularly engineering). This advanced course in writing familiarizes students with the discourse practices prized in their disciplinary and institutional communities-and helps them to manage those practices effectively in their own written work. In this way the course teaches those writing strategies and tactics that scientists and engineers will need in order to write successfully on the job. Accordingly, students in the course can expect to
- Discover and understand the discourse features that distinguish their disciplinary and institutional communities from others.
- Discover and specify the purpose(s) of their writing.
- Develop a range of writing processes appropriate to various writing tasks.
- Identify their readers and describe the characteristics of their readers in a way that forms a sound basis for deciding how to write to them.
- Invent the contents of their communications through research and reflection. Arrange material to raise and satisfy readers' expectations, using both conventional and rhetorical patterns of organization.
- Reveal the organization of their communications by using forecasting and transitional statements, headings, and effective page design.
- Observe appropriate generic conventions and formats for letters, résumés, memoranda, and a variety of informal and formal reports.
- Design and use tables, graphs, and technical illustrations.
- Compose effective sentences.
- Evaluate their documents to be sure that the documents fulfill their purpose and to ensure that they can be revised if necessary.
- Collaborate effectively with their peers in a community of writers who provide feedback on each other's work and occasionally write together.
- Write several specific kinds of documents that recur in technical and scientific communities.
- Employ computer technology effectively in the solution of communication problems.
- Communicate in an ethically responsible manner.
SAMPLE SYLLABUS MATERIALS
Course Policies
Assignments: In this course, I will try to hold you to the professional standards that prevail in the working world. For example, of the requirements listed below, your employer will take some completely for granted, such as promptness, neat appearance, and correct mechanics.
Promptness. In this course, as in the working world, you must turn in your work on time. All projects are due at the beginning of class on the dates indicated on the syllabus. Assignments turned in late will normally be penalized one letter grade per day unless you have made other arrangements with me in advance.
Appearance. All work should be neatly typed, using standard margins and spacing. Whether it is a letter, a memorandum, or a report, your communication should exhibit appropriate format. In general, letters and memos should be single-spaced with a blank line between paragraphs and reports should be double-spaced. Rough drafts may be neatly handwritten; final drafts should be prepared on a word processor. You are responsible for separating pages and observing appropriate margins.
Grammar, Spelling, Proofreading. At work, even a single error in spelling, grammar, or proofreading can jeopardize the effectiveness of some communications--depending on the rhetorical situation. My grading will reflect the great seriousness with which these matters are often viewed in the working world. If you would like special assistance with any of these skills, I can recommend sources for extra help.
Back-up Copies. Always prepare two legible copies of each major assignment. I will grade one copy and hand it back; the other copy will be for your own safe keeping and permanent records. Sometimes I will request a "clean" copy of one of your papers so that I can use it as a sample, in packets such as this, to illustrate effective and problematic responses to assignments. I won't use your work without obtaining your permission.
Revisions. You will receive feedback on your writing from me and/or from your classmates at various stages of the writing process, from planning through the draft you hand in for a grade. You should try to apply the comments, not only to improve the particular paper you are working on at the time, but also to develop your strategies for writing in general. In some sense, no paper can ever be finished or perfected. However, if you think you can significantly improve a paper after it has been graded, you are welcome to do so if you consult with me during office hours about what you plan to do. If the grade for a revision is higher, it will replace the original grade. Note: cleaning up grammatical and stylistic problems does not constitute significant improvement. You must submit the original, graded paper with your revision.
Attendance and Preparation: I expect you to attend class everyday and to have your textbook and packet of supplementary materials with you. If you have unexcused absences, your class grade may be docked up to one full grade. Excused absences must be arranged in advance and all work missed must be made up. In an emergency, please call or e-mail me.
It is particularly important for you to attend and be prepared to participate in in-class workshops on drafts of your paper. The more you have written before a peer review session, the more you will benefit from the session. You are responsible both for making high quality comments on your classmates' papers and for considering classmates' comments in revising your own work. Your draft should be complete enough for you to be in a position to ask someone to help you with it. If you must miss a workshop, hand in your draft early and arrange to comment on another classmate's paper. Under no circumstances will I accept a "final" paper unless I've seen your rough draft.
Conferences: I strongly encourage you to see me when you have questions about an assignment, when you would like to try out some ideas before a paper is due, or when you have questions about a comment on a draft. You should also see me for help with particular writing problems, to resolve differences about grades, or to suggest ways to improve the course.
Grades: When grading each of your assignments, I will ask one overriding question: "Does it work?" That is, would your communication have the intended effect on the reader you are addressing in the world outside the classroom. I will, of course, recognize the difference between a competent performance (a "C") and good and excellent performances ("B" and "A"). A competent performance is one that stands a reasonable chance of succeeding; an excellent performance is one that seems assured not only of success but also of winning praise.
A - superior; the work is of near professional quality. The document meets or exceeds all the objectives of the assignment. The content is mature, thorough, and well-suited for the audience; the style is clear, accurate, and forceful; the information is well-organized and designed so that it is accessible and attractive; the mechanics and grammar are correct.
B - good; the document meets the objectives of the assignment, but it needs improvement in style, or it contains easily correctable errors in grammar, format, or content, or its content is superficial.
C - competent; the document needs significant improvement in concept, details, development, organization, grammar, or format. It may be formally correct but superficial in content.
D - marginally acceptable; the document meets some of the objectives but ignores others; the content is inadequately developed; or it contains numerous or major errors.
F - unacceptable; the document does not have enough information, does something other than the assignment required, or it contains major errors or excessive errors
Your grade in Technical Writing will be determined by the grades you receive on written assignments, according to the following weighting:
#1 Job Application Package 15%
#2 Technical Definition/Description 10%
#3 Instruction Set 10%
#4 Report for Decision Making 30%
#5 Progress Report 10%
#6 Usability Memo 15%
#7 Homework and Participation 10%
Portfolio: The portfolio is a record of your semester's formal work. It should contain the paper trail for 6 major papers, including drafts with comments, peer review forms, and optional revisions.
Plagiarism (Cheating) Talking over your ideas and getting comments on your writing from friends are NOT examples of plagiarism. Taking someone else's published or unpublished words and calling them your own IS plagiarism. Plagiarism has dire consequences, as spelled out in the English Department regulations included in this packet.
Nota Bene The Pennsylvania State University encourages qualified people with disabilities to participate in its programs and activities and is committed to the policy that all people shall have equal access to programs, facilities, and admissions without regard to personal characteristics not related to ability, performance, or qualifications as determined by University policy or by state or federal authorities. If you anticipate needing any type of accommodation in this course or have questions about physical access, please tell me as soon as possible.
SAMPLE ASSIGNMENT SHEETS
Assignment #1: Job Application Packet
Most people obtain jobs through a multi-stage process. First you research the types of jobs you are qualified for and the types of employers you would like to work for. Then you try to convince specific employers to consider you for a job. These days, most employers have too many applicants per job to interview each personally. These employers sort through job application packages (resumes and cover letters) to decide which applicants to consider further. So your first communication with your future employer is likely to be in writing and must persuade him or her to continue the conversation.
For this assignment, you will write:
Two cover letters addressed to different prospective employers and that apply for two different types of jobs. The letters should highlight different aspects of your experience relevant to the different jobs.
Two resumes that may well differ significantly in content or in layout or both. The choices of content and layout should emphasize appropriate experience for each job.
A cover memo addressed to me that overviews the two jobs, reviews what you know about these particular employers, and describes the strategies and tactics you have used to adapt your letter and resume to each situation. I expect you to make good use of the information in this memo in the arguments you present in your cover letters to the employers.
Memo
Write a brief memo (no more than two pages) addressed to me that will help me read, understand, evaluate, and "coach" your resumes and cover letters. For each of the two jobs, the memo must contain a separate job description and audience analysis, as well as a commentary highlighting how you adapted your resumes and cover letters to the different jobs. Since the memo will be of use to you in designing the rest of your job application package, you probably should think about it early-even begin drafting it early. But you should look over it carefully at the very end of the project to make sure that it tells me "how to read" your resumes and cover letters.
Job Description. You may base your job description on job listings that you find in a professional or trade journal, on the Internet, or in other resources on campus at Career Services . The jobs should be different enough that you will have to emphasize different parts of your experience to qualify for the positions. You may also (with my permission) write for a summer job, an internship, or for a scholarship or other award. Note that you must hand in copies of the job ads you use.
Audience Analysis. Investigate the particular companies you are applying to. You may obtain information on many companies from the library, on the Internet, or from Career Services. You may also contact the personnel office of the company directly. Then write one or two paragraphs that specify any special qualities or experience that this company may be looking for in its employees. For example, suppose you are applying for a job as a chemical engineer. A small company may be looking for an engineer who can work on a variety of projects, while another may be looking specifically for someone with experience with polymers. This is also the place to describe anything you know about the particular person you are writing to. Note: I expect you to make extensive use of this information in your cover letter. It might also have a big impact on the organization and choice of details in your resume.
Rhetorical Analysis. Describe how you adapted each resume and cover letter for its particular type of job, company, and reader and why you made those changes. Normally, your reasons will be closely related to the information in the job description and audience analysis.
Resume The purpose of the resume is to describe your qualifications for a type of job. Since this assignment requires you to apply for two somewhat different jobs, you may well decide to create two somewhat different resumes.
Content. Your resume should include contact information and relevant details of your educational training, professional training, special accomplishments, and skills. A resume is not a life history. The goal is to argue that you are qualified for a particular type of job and that you would be a capable, responsible, and personable employee who communicates effectively.
Format. Your format may be traditional or innovative as long as it is appropriate and as along as the information is highly accessible and is organized in a way that highlights the most important items (from the employer's perspective).
Style. Your style should be fairly formal. You need not use complete sentences, but you should use a concise, active style and show consistency in expression from section to section.
Cover Letter
While your resume is addressed to any employer with a certain type of job opening, the cover letter is most effective when tailored to a particular employer. The purpose of the cover letter is to persuade that specific employer to grant you an interview. Just as you appreciate being treated as an individual rather than as a statistic, so does an employer. Are you applying hit-or-miss to every company in the country? Or have you invested some effort into finding a company that you are well suited for?
Content and Organization. The opening of your letter should establish why you are writing to your reader. Be explicit about the fact that you are looking for a particular kind of job and explain why you would like to work at that particular company. Preview the body of the letter by stating your major qualifications for the job. The body of the letter develops each qualification with specific evidence. The goal is to show the reader both that you know what that specific company needs and that you have what it takes. You may organize this section in various ways: around your training and experience, around what the job or the company requires, or some other way. The letter should close by inviting a response.
Style. Cover letters are difficult to write because they aim at somewhat conflicting goals. On the one hand, you want to make a good first impression. So you want to sound polite and fairly formal. On the other hand, you want to stand out from the crowd-otherwise, why should the employer hire you rather than any of the other applicants? The best policy is probably to talk to your reader as directly and naturally as possible. Avoid hype.
Format. Use a conventional business letter format. Be brief: if possible, stick to one page.
Standard for Correctness Employers impose a strict standard of correctness on application materials: An error is the equivalent of a bad spot on your shirt. Accordingly, I will mark this assignment on a somewhat stricter scale than usual. If any letter or resume contains more than two typographical or grammatical errors, I reserve the right to dock the entire package one letter grade. I will dock the package even more if there are numerous typographical or grammatical errors.
Assignment #2: Technical Definition/Description
Engineers and scientists are often required to describe a technical object, concept, or process to someone who has little knowledge or experience with the subject at hand. For example, your engineering firm might write a proposal to bid on a contract to develop a helicopter for the Defence Department; one section of the proposal would be a detailed description of the product your propose to develop. Technical descriptions are used before products and processes are developed (as part of proposals and planning documents), during development (in progress reports, for instance), and afterwards (as part of marketing and promotional literature and technical support documents.
There are two different kinds of technical descriptions to consider. Choose whichever one is appropriate, depending on your topic.
A product description explains the features of a specific device, like a scientific instrument or computer program. Possible topics include devices that are specific to your field, or devices you use in everyday life:
- Manual grass clippers
- Fuel cell
- Battery
- Catalytic converter
- Manual can opener
- Your favorite computer or video game
- A specific car model
A process description explains how a complex event occurs, including a mechanical process (i.e. how donuts are made) or natural event (i.e. how lightning is produced). You can choose a process that is specific to your field, or one that people may be curious about:
- How a specific drug works
- How steel is made
- How fuel cells work
- How a computer compiles and executes a program
- How your microwave works
- How food products are irradiated
Audience and exigence: Select an audience that would be interested in learning about the process or product you explain. For example, you could assume an audience of students reading about your topic in a textbook. You could write a marketing document to persuade people to buy a product. Or, you could write a description that would be part of a proposal being sent to a potential client.
Gathering Information: Look for technical support documents for the product or process you are describing. Search the web courses. for technical documents that are related to your topic, or draw on material you've used in other courses.
Contents
For product descriptions, start with a definition of the product and its various parts. Next, describe each part in more detail, including its dimensions, materials, function, and relation to other parts. Conclude with a description of one complete operating cycle for the product.
For process descriptions, start with a definition of the process and the different steps it involves. Next, describe each step in more detail. Conclude with a summary of one complete cycle in the process.
In either case, though, remember to choose contents based on the audience's level of interest, experience, and knowledge about the topic.
Format: Include design features to help the reader locate information and understand the product or process better: diagrams, headers, bulleted lists and so on.
Length: 2 pages.
Visuals: You can either develop your own visuals (a rough sketch is fine if you don't know how to prepare one with a computer program), or include a "reference visual" (a published copy with instructions on how it would need to be adapted to suit your purpose). Be sure to cite the source for any published visual you would use.
What to hand in
- Your planning worksheet
- A list of source materials you used (including sources of visuals, product information, etc.)
- Your rough drafts
- Your final draft
Assignment #3: Instruction Set
Instruction sets are common technical documents for many disciplines and occupations. Employees read instructions to learn how to assemble a product or complete a procedure. Supervisors write out company policies that oftentimes serve as instruction sets. Customers read instructions for using a product. For this assignment, you will develop a set of instructions advising users to perform a specific task.
Before deciding on a task, consider the following guidelines:
- Choose something you are very familiar with. It can be something related to your field of study (i.e. how to use a particular piece of laboratory equipment), or something related to a more general audience (i.e. how to learn to juggle).
- Your audience should be someone who has never performed this task before.
- Your audience should have a general understanding of the topic area.
- Choose a task with an appropriate level of difficulty-neither too easy nor too hard to explain in the space allotted.
- The task may involve a device: assembling it, operating it, or fixing it. Or it may involve some process (e.g., registering using eLion). You may choose the task from a course, a hobby, a previous job, or some skill you've acquired in school.
- The device or process should have discrete parts or steps that are fairly easy to name and refer to.
- Your task should be explained in two-three pages of written instruction, with visuals.
Topics
Your instructions should help users to perform any kind of task that requires several steps or stages. Here are some topic ideas:
- how to change the oil in your car
- how to iron a shirt
- how to add another component (CD-ROM, hard drive, sound card, etc.) to your computer
- how to groom a dog
- how to reformat your hard drive (yikes!)
- how to fully use your ATM card (include many options, not just how to withdraw and deposit)
- how to cook a turkey
- how to operate a Rotovap
- how to French braid your hair (or someone else's)
Rhetorical Situation
Before you begin to write, consider the rhetorical situation for your instructions. Use the rhetorical analysis worksheet to help you determine the purpose, audience, and context for your instructions. Next, use the instructions planning worksheet to help you develop the contents for your instructions (see below).
Contents
Depending on the nature of your task, you may wish to include some or all of the following contents.
- Introduction or background information. Here you'll provide your reader with the following information, if applicable:
- an overview of the steps needed to complete the task
- definitions of terms or concepts they need to know before they proceed
- cautions or warnings that apply to the task as a whole
- a sense of how long the task will take
- where they should perform the task (i.e. in a well ventilated area, outside, on a flat surface, etc.)
- List of materials or ingredients needed.
- Diagrams, drawings, photographs, figures, or tables. (Pencil sketch or description of the diagram is fine).
- Include captions for each illustration or figure.
- Label charts and diagrams clearly.
- Make sure to give a sense of scale and orientation.
- List of steps, in chronological order.
- Make sure you use active verb commands.
- Phrase each step clearly and concisely.
- Provide "feedback" that informs the reader what will happen after they complete each step.
- Include warnings or cautions before readers will encounter problems.
- Break long lists into sections with appropriate sub-headings.
- Make sure sub-headings and steps are phrased in parallel form.
- Troubleshooting tips.
- Glossary of key terms and definitions.
Organization
Obviously, instructions are normally organized in a chronological order. Beyond that, here are some other guidelines:
- The focus of instructions should be on tasks the user performs, not capabilities of a system or product. Headings and sub-headings should reflect this focus. For instance, "Compiling your program" puts the focus on the audience's task, while "Program compilation" puts the focus on the system.
- If there is no necessary chronological order for your instructions, then choose another rationale for the organization. For example, you could move from more to least important tasks, from general to specialized tasks, from most to least common, and so on.
Format
Your instructions should be designed to accommodate multiple reading styles and user needs. Accordingly, your design should include:
- A clear hierarchy of headings and subheadings.
- Well-chosen fonts. For print documents, sans-serif fonts are usually best for headings; serif fonts are best for body text. (For online documents, the reverse is true.)
- Numbered lists and bulleted lists, where appropriate. Know the difference. Make sure bullets and numbering are consistently formatted. Do not number of bullet lists with fewer than two items.
- An appropriate amount of white space-neither too much nor too little.
- Effective use of alignment. Centered alignment may make it harder for users to skim headings and sub-headings; left alignment or indentations can be more effective for this.
- Effective use of contrast. Too much contrast means that nothing stands out; too little makes it hard for users to find what they need. Consider emphasizing elements like headings, key words, and warnings.
- Consistently used design features. Decide which fonts, font sizes, and forms of emphasis you will use and apply them consistently.
Length should be 3-5 pages.
What to hand in:
- Your instructions
- Your planning worksheet
- Your rough drafts and draft worksheets
Evaluation
Audience Accommodation: The instructions are appropriate for the intended audience. They're written from a user-centered, rather than system-centered, perspective. They anticipate the user's questions, difficulties, and needs.
Content: The instructions include all of the information needed to complete the task at hand. Background information, warnings, and definitions are included where appropriate.
Organization: The instructions are organized logically. Items within numbered lists are organized chronologically. Sub-sections are clearly marked with headings.
Format: The instructions include each of the format features listed above. The overall design is clear and consistent. The instructions use fonts, white space, contrast, alignment, headings and sub-headings appropriately and consistently.
Style: The instructions effectively create a professional ethos. The tone is effective for the audience. Instructions are written as active voice commands. Headings and numbered and bulleted items are in parallel form. The document is free from typographical or grammatical errors.
Assignment #4: Technical Report
For Assignment #4, you will write a report for decision making (or what is sometimes called a recommendation report). Your report will aid a reader in solving a problem by presenting the results of research and your evaluation of the significance of the findings. The recommendations will suggest specific actions to solve the problem. Your research methods will probably include library (or secondary) research, but since the problem is particular to a time and place, you will also conduct research by "primary" means of information gathering. The report will highlight criteria for decision making in its structure.
Your report will answer one of the following questions:
- Will X work for a specific purpose? (feasibility study)
- Is X or Y better for a specific purpose? (comparative analysis)
- Why does X happen, and what can be done about it? (cause-effect analysis)
- How can we use X to best advantage?
The Problem
Look for a project with practical application; that is, be able to define how a specific reader will use your report. The best projects are real and "local" rather than theoretical. (Don't ask huge questions, such as whether universal health care is feasible in the United States.) Practical topics relate to your work, organizations, or field of specialization. The recommendation must require the investigation of at least two criteria for decision making in at least two of the three categories: technical, managerial, and social (see pp. 506-510).
Research
You must use at least two types of research, such as letter of inquiry, questionnaire, interview, site inspection, Internet research, and library research. (If your project is an analysis of uses of the Internet in your discipline, one type may suffice.)
Format
Your report will include the following elements:
- letter of transmittal
- title page with descriptive abstract
- table of contents
- list of visuals (if you have more than two)
- glossary (if necessary)
- executive summary
- introduction
- discussion section organized according to criteria for decision making
- conclusions, recommendations
- appropriate documentation, according to the style used in your field
- appropriate supplements (e.g., copies of research instruments, such as survey forms)
- visuals (tables, graphs, drawings, photos); at least one visual is required
The body of the report, including introduction and conclusions, will probably run about 10 double-spaced pages in 12-point type. The preliminary and supplemental pages will be additional. Number pages, use a running header, and use headings in the report text. Note that the report is worth 30% of your grade for the course. Please manage your time well.
Sample Topics Is it feasible to install speed bumps on Shortlidge road?
Is it better for the contracting company I work for to install concrete slab driveways or regular asphalt driveways in the development they're working on?
Which type of marketing would be better for the Meals-on-Wheels new promotional campaign: flyers and brochures, or a public relations video?
Which law school is better for a career in intellectual property, Dickinson or Pitt?
Why do the necks of subjects ache when our lab does tests for zero-gravity muscular motion, and how can we fix the problem?
Why are the Internet connections so slow in Pollock Hall, and how can we make them faster?
Are more bicycle paths feasible for the Penn State campus?
Is a Diver Propulsion Vehicle a feasible project for the senior design project in mechanical engineering?
What resources are available on the Internet to support research in my discipline? (Categorize by type, recommend particular ways to use the net for specific inquiries.)
Evaluation criteria
I will evaluate the reports according to these expectations:
The executive summary reflects the entire report concisely. Introduction, findings, conclusions, and recommendations are covered. Significant factual information is present. Sentences are efficient, and the summary does not exceed one page.
The introduction states a problem (with who-what-when-where-why-so what information), identifies a research question, explains methods, and forecasts the rest of the report.
The body sections reflect criteria for decision-making. Headings are parallel. Each body section is a mini report, with an introduction, findings, and conclusion. The introduction defines the issue and explains its significance. The findings report what you have discovered through research. The "conclusion" (just on that issue) tries to define the significance of the findings for the research question and to reconcile any conflicts.
The conclusion section for the entire report weighs the results from all the criteria and answers the research question. All the criteria should be accounted for. The conclusion does not introduce any new criteria. The section includes interpretive (not just factual) statements: words like "more important because..." or "a more immediate need" or "long term benefits outweigh short-term costs." You put the findings for each criteria in relation to one another. You justify and explain your answer to the research question. The conclusion answers the research question: An explicit statement will say something like "A is the better choice" or "X is not feasible at this time."
The recommendations direct specific action (without explanation or justification). The recommendations may (but do not have to be) in list form. If there is a list, the verbs may be "command" verbs (imperative mood). Items in the list are in parallel form.
All the report parts are present (title, table of contents, executive summary, report, illustrations, references etc.). Illustrations support the argument (they highlight important information that would be harder to understand with words alone) and they are constructed and labeled according to conventions. Format reveals the structure. Headings show main divisions. A running head and page numbers help readers find their place. Preliminary pages are numbered with roman numerals. Sentence style emphasizes strong verbs. Grammar and mechanics are correct. References are complete and accurate. The citation style is the one used by the writer's discipline (e.g., APA for social science and business, reference notes for engineering, MLA for literature, Chicago-author/date for technical writing).
AND, finally: The problem is significant, research is good, reasoning is sound. The report is convincing and important.
Assignment #5: Progress Report
Definition, purpose, and resulting action
A progress report updates a project supervisor on work accomplished and work remaining on a long-term project. The report helps an organization coordinate related projects. The report should persuade the supervisor that you will achieve the intended goals by the specified deadline. The report also offers an opportunity to propose a slight change in focus or methods or to request additional support. If the progress is satisfactory, the supervisor will continue support of the project (and of the investigator). If progress is not satisfactory, a project may be canceled or assignments redefined. Text reference: pp. 477-484.
Your assignment
Prepare a progress report on your major report project. The progress report should:
- summarize the project,
- describe accomplishments (e.g., research, writing, construction of graphics-be specific),
- identify work remaining,
- evaluate the progress overall.
You may describe problems encountered (especially if the problems will shape the final outcome, such as a shift in purpose), but don't whine. If possible, explain how the problems have or will be resolved. The report should be positive in tone without being inflated in its assessment. The best way to accomplish this goal is to be specific about accomplishments. The best way to be specific about accomplishments is to have some! Plan your research and writing so that you will be able to describe your progress in a way that attracts the approval of a supervisor. In other words, work on the most important tasks first, and budget your time wisely.
The planning worksheet you developed for the recommendation report becomes a measure of the accomplishments. Are you on schedule? Have you varied that plan, and if so, how?
Report format, structure, and style
Present your report in memo format. You can address the report either to me or to a client for whom you are preparing your recommendation report. (Note that contents will differ somewhat depending on your main audience. Your client is less interested in writing tasks than I am, but we are both interested in the results of your research.)
Layout and Design: Use headings to show where the subdivisions begin and end. Consider using visuals (i.e. tables, Gantt charts) to display spatial information. Number pages. The report will probably be 2-3 typed pages (depending on type style and spacing mostly).
Structure:
- Begin the report with a brief overview of the project's purpose and scope.
- For the body of the memo, describe the work you have accomplished so far, any problems you have encountered, and what remains to be done. There are two essential ways to structure the progress report: chronologically (work completed-work in progress-work remaining) or by task (interview, library research, writing). Either way, you need to be very specific! For instance, rather than saying "conducted interview," say "interviewed G. Smith and P. Jones regarding feasibility of computer-based instruction to teach productivity skills".
- Optional: Within the body of the memo, or at towards the end of the report, writers sometimes include a table to summarize tasks and completion dates. You may also wish to include a separate section describing any complications you've encountered and how you plan to address them.
- For the conclusion, indicate whether the project is on schedule according to the management plan.
Style: Use active voice verbs and concrete nouns to suggest achievement. Save evaluative terms ("good") for the overall assessment in the conclusion.
Evaluation criteria
- The document meets the objectives of a progress report in content and organization.
- A brief project description orients the reader to the project. The content is specific, and achievements and problems are easy to identify. Achievements are reasonable for this point in the project.
- Organization and format make it easy to find the relevant information.
- Style is businesslike: the writer neither whines about problems and looks for excuses nor inflates the accomplishments unreasonably. Action verbs suggest accomplishment. Format, grammar, and mechanics conform to conventions for memo reports.
Assignment #6: Usability Memo
This last assignment serves as a kind of final examination in that it tests how well your have learned the concepts in this course, especially the rhetorical concepts of audience, purpose, organization, style, and visual design.
As you have learned in this course, technical communication happens all around us; it is indeed a central part of our professional and personal lives. You consult a cookbook to figure out how to make mashed potatoes. You access the help menu to find out how to put footnotes into a Word document. You check the ITS FAQ to determine how to upload files to your Website. Yet, more often than not, these activities lead to feelings of frustration and powerlessness. How come technical writing so often doesn't work? Why doesn't anyone know how to program a VCR? How come 80% of child safety seats are improperly installed? And why is filing taxes such a painful process?
In this assignment, you'll write a usability memo that helps to answer this question. You'll apply the basic principles of technical communication to determine what makes a document effective or ineffective. People in the field of usability would call this kind of investigation a heuristic evaluation. In such an evaluation, researchers apply the "best practices" of technical communication in the research literature to a document in development, in order to assess its usability for readers (although one of your other goals is to convince me that you have learned the basic principles of technical communication).
For this assignment, you will: (1) choose a piece of technical communication, a document, to analyze (this is a very important part of the assignment, for some documents will be easier to analyze than others); (2) evaluate the document for usability; (3) write a usability report that organizes your analysis in both a logical and convincing way.
1) Choose a Document
Locate a piece of technical communication that you might use in your everyday life. In other words, you should be a part of the target audience for the instructions.
Here are some ideas (don't be limited by them):
- A set of instructions you might use to perform a task. For instance, you could evaluate the instructions that come with your VCR or microwave.
- Online help that accompanies a software program you use.
- A technical report you can download from an organization's Website.
- A resume and/or cover letter you find on the Internet.
- A technical definition or description from a textbook.
- A section of a Web site that serves technical communication purposes.
As a first step, try to gather at least three or four possible documents. Do not just choose the first one you find. Then, consider the length and complexity of the document. If your document is very long, you won't be able to analyze it in enough detail. If your document is too short, you might have trouble coming up with enough elements to discuss. Next, take some time to look through the documents briefly and consider them from a rhetorical perspective. If the document is already perfect, you won't have much to say in your memo. Try to find a document that has at least some rhetorical problems that are immediately obvious (you'll find more as you work through the worksheets for this assignment). That way, you'll definitely have some factors to discuss in the body section and some recommendations to make at the end of the memo.
2) Evaluate the Document for Usability
First, fill out the planning worksheet for this assignment. This will help you to get a better sense of the audience and purpose for your document.
Next, use the usability worksheet to evaluate the instructions. As you work through the checklist, try to put yourself in the place of a user who is actually reading the document. In other words, it's not just a matter of whether a certain element is in the document, but whether or not the user would reasonably be able to find and understand that element. For example, an instruction manual might include a 1-800 number for customer service, but the number might be buried in fine print at the end of the document where no one will see it. An online help section might provide instructions on how to do "Mail Merge," but it might not explain to the user what "Mail Merge" is or why one might want to use it. Make sure to note any place in the document where a user might have trouble performing a task or understanding content, places where users might have questions, places where terms need to be defined, and so on.
3) Write the Usability Memo
Your report should take the form of a memo, and your memo should be addressed to the person or group in charge of the document you're reporting on. For instance, if you are analyzing the effectiveness of some instructions from the ITS Website, you would address whoever is in charge of writing documentation for that site. Call or e-mail ITS to find out. If you can't, make up a name and position, but remember that you are addressing the person who wrote (or managed the writing of) the document you are reporting on. As you write, provide specific details and examples to support your usability claims. Since your audience may not be familiar with the principles we've discussed in class, you should explain why a certain feature makes the document ineffective or why a certain suggestion would improve the document.
Contents
- Introduction. Briefly describe the purpose of the memo and give an overview of what it will cover. You should give the reader a sense of why this memo will be important for them (i.e. how it will benefit their organization or company, why usable documents are important).
- Rhetorical analysis. Who is the audience for this document? What is the purpose of the document? What are the different needs, tasks, or questions the audience has? In what context will the audience be reading the document?
- Usability analysis. See the usability worksheet for questions to address here:
- Content,
- Organization,
- Style,
- Design,
- Ethical, legal, and cultural considerations.
- Conclusions. Summarize your analysis.
- Recommendations. Make specific recommendations to improvement the document.
Format
See pages 592-595 in your textbook for sample memos and their conventions. You can change certain design features for the memo (e.g., type face and size), but you should include the following:
- The word Memo or Memorandum at the top
- The Date, To, From, and Subject lines
- Topic headings (this memo won't be short)
- Proper paragraph spacing (single space within paragraphs, double-space between paragraphs)
- Headers on pages after page 1
- Your initials beside the from line
- Copy, distribution, and enclosure notations if applicable
The length should be at least three (3) single-spaced pages.
Grading & Evaluation
Content. The memo includes each of the sections listed above. Within each section, the usability claims are supported by concrete examples and evidence. The section goes beyond reporting answers to the usability questions: it explains why a given item is effective or ineffective. That is, the memo moves well beyond description and into analysis.
Organization. The memo is organized in a logical manner overall and within each section. Headers mark each section.
Format. The memo includes each of the format features listed above. The overall design is clear and consistent. The memo uses fonts, white space, headings and sub-headings appropriately and effectively.
Style. The memo creates a professional ethos, one that demonstrates a solid understanding of the basic principles of technical communication. The tone is effective for the audience. The document is free from typographical and grammatical errors.
What to hand in:
- A copy of the document you are working with,
- Your planning worksheet,
- Your usability testing worksheet,
- Your usability report, including rough drafts and the final copy.
ADDITIONAL ASSIGNMENT OPTIONS
The following assignments were developed in part and provided by English graduate students connected with the Leonhard Center Technical Writing Initiative.
Article Adaptation
As a technical writer, (or future engineer, scientist, etc.), you will often write for technical audiences, who understand the terminology, concepts, and values of your discipline. However, you will also need to write about technical information for a non-technical audience, or an audience that may not share your terminology, values, or concerns. This type of writing can be difficult, but adapting information for a non-technical audience is a valuable skill to have. For instance, engineers often report to local government officials, doctors need to explain procedures to hospital boards, and research scientists must relate their work-in-progress to grant-funding foundations. This assignment is designed to give you experience in defining and explaining research findings to a specific audience who needs the information but lacks your background knowledge in this area.
For this assignment, you will choose a technical document or article from your discipline and write a document explaining it to an audience outside that community. Imagine that a co-worker, colleague, client, or some other audience wants you to explain the findings of that article to them. Your readers are probably smart people-but they don't share the expertise you have in your specific field. Your job is to "translate" the article from a highly scientific or technical language into something that audience can understand.
The format for this assignment is open, but it will depend on the audience you choose. Here are some possible choices:
- Write a memo to your boss (whose background is in finance) explaining one of the latest developments in your field.
- Write a pamphlet for students at Penn State, patients at a healthcare clinic, or visitors at a trade show explaining a new technology or development.
- Write an article for a mainstream magazine (like Popular Mechanics) that describes why a new discovery or development is important and how it works.
- Create a website that will provide amateur scientists with information about a recent scientific discovery or experiment.
How to get started:
- Start by browsing through some academic journals in your field. Look for articles that are interesting, current, and applicable to a non-technical audience. You should choose a topic which interests you, and one with which you are comfortably familiar, but you should also consider the audience and purpose for your adaptation article.
- Next, consider the audience for your article. Who will want to read about this? For what purpose? Given your topic and audience, what format (pamphlet, website, article, etc.) would be most appropriate?
- Consider how you can adapt your article for the audience and format you chose. What do your readers already know or not know about your subject? How can you explain something so that your readers understand as much as they need to know? What terms will you need to define? What information is most important, and what can you leave out?
- Consider the visual layout and design for your article. (Look at some examples from your chosen publication for an idea.) What kinds of headings/sub-headings are used? Can you use diagrams or illustrations to help explain key terms or concepts?
Specifications:
- Length -- 2-3 pages
- Format - Depends on what you choose to do. Whatever it is, follow the guidelines we've used so far-consistency, clear use of headings, etc. If applicable, follow the conventions for that type of document.
- Citation -This will also depend on the format. In most cases, you will use informal citation rather than formalized citation styles (e.g., APA, MLA). That is, instead of using footnotes or parenthetical citations, provide the source of your information in the text itself. (e.g., "According to an article published in Nature.," "Josephine Smith, professor of Biological Sciences at Penn State University, states.") For a website, though, you could use hyperlinks to the original document (if it's available online).
Evaluation Criteria
- Audience Accommodation: Does the document effectively adapt technical information to the needs of the audience? Does it address the audience's concerns, values, knowledge, beliefs?
- Content: Does the article fully develop and explain the relevant content from the source article?
- Organization: Do the elements in the article follow a logical organization based on the audience and genre?
- Style & Mechanics: Is the writing clear and concise? Are sentences written in the active voice, using strong action verbs? Is the tone and formality appropriate for the audience? Is the article free from typographical or grammatical errors?
- Layout & Design: Does the document follow the principles of effective design (consistency, alignment, repetition, proximity)? Are headings and sub-headings used appropriately?
What to hand in: A copy of the original article, your planning worksheet (to remind me of your audience, purpose, etc.), your rough drafts, and your finished document. Secure all documents with a clip or put them in a folder. Article Adaptation Materials
Locating academic journals in your field:
Researchers in every academic discipline publish their findings in highly specialized academic journals. An academic journal is different from a trade journal, magazine, or newsletter. In order to be published in an academic journal, an article must first be peer-reviewed. That means that other professors or researchers in the field read the article, comment on it, and recommend to the editor whether or not it should be published. The peer-review process ensures that each article is well-researched, credible, and important to the discipline.
To locate academic journals in your field, go to the Penn State library website. Click on Research Tools, then choose By Subject. You'll see an alphabetic list of academic disciplines. Click on your major or discipline. You'll be taken to a web guide for research in your field. Each discipline has a slightly different web guide to scholarly research. Look for a list of academic journals or a database where you can search for journal articles.
Or, ask one of your professors what the top journals are in your discipline.
Once you've found some journals in your field.
Most academic journals have websites. Some provide articles online for subscribers. So do two things:
Look for the journal's website on the Internet and evaluate their credibility. Even if the journal does not provide articles online, you can often examine the editorial policy and skim tables of contents. Look at the editorial policy and determine whether or not the journal uses a peer-review system. If it doesn't, then you should look for a more reputable journal.
Search for the journal on the CAT. Be sure to select "journal title" from the dropdown box. Penn State now subscribes to online versions of many journals. Look for a web link when the search comes up. If there's no link, you'll have to actually get your butt over to the library. Note the location of the current issues of the journal-sometimes there in a different spot from less recent issues.
Article Adaptation - Planning Worksheet
1. What article will you be adapting? Give the title and the name of the journal it came from.
2. Who is the audience for your adaptation? How does this topic relate to the audience's concerns, values, beliefs, and interests? In other words, why should they care about the topic?
3. What format will you be re-writing for? How are these kinds of documents usually written? (Think about style, organization, use of visuals, and so on).
4. What does your audience know about the topic already? What might not they know?
5. What technical terms or concepts will you need to explain? How can you define them in terms the audience will understand? (i.e. definition by metaphor, comparison-contrast, negation, etc.)
6. What visual elements can you use to attract the reader's attention or to illustrate relevant terms, concepts, relationships, trends, or ideas?
Assignment: Article Adaptation-Draft Workshop Checklist
Audience accommodation:
- Does the document effectively adapt technical information to the needs of the audience?
- Does it relate to the audience's concerns, values, knowledge, and beliefs?
- Is the level of technicity, formality, and detail appropriate for the audience and publication?
- Is it clear why the audience should care about this?
Content:
- Does the document fully develop and explain the relevant content from the source article?
- Are key terms and concepts defined and explained?
- Are key systems or processes described?
Organization:
- Does the document follow a logical organization based on the audience and genre?
- Does the writer use forecasting statements, topic sentences, and sub-titles to indicate the organization?
- Is it easy to determine what that organization is at a glance?
Style & Mechanics:
- Is the writing clear and concise?
- Are sentences written in the active voice, using strong action verbs?
- Is the tone and formality appropriate for the audience?
- Is the document free from typographical or grammatical errors?
Layout & Design:
- Does the document follow the principles of effective design (contrast, alignment, repetition, proximity)?
- Are headings and sub-headings used appropriately, if applicable?
- Are fonts, white space, bulleted and numbered lists, etc. used consistently and appropriately?
Assignment: Collaborative Evaluations
After working collaboratively on the last assignments (and others throughout your college career), you have gained insight into the promise and peril of group work. This last assignment offers you the chance to design an evaluation form for yourself and your peers to complete. Your evaluation form must follow the specifications below, but the questions will be largely up to you. This is an individual assignment. We will have a normal rough draft session for this assignment on Tuesday, May 1st. As you design these forms, keep in mind that 5% of your grade will be based on your groups' evaluation of your collaborative effort AND that you will have to fill out your own form. A letter of transmittal should be attached to the evaluative form.
Objectives:
- To reflect on the ethical and rhetorical considerations of evaluative documents
- To understand technical writing from a managerial perspective
- To better determine the qualities you look for in collaborative team members
- To respond to the collaborative work done this semester
Specifications-your evaluative form must include the following elements:
- A title
- An introductory sentence or two explaining the form
- All five types of questions from the list below
- long answer (at least a paragraph)
- short answer (at least 2-3 sentences)
- multiple choice (multiple answers provided, respondent mush choose one)
- check box (multiple answers provided, respondent can choose all that apply)
- chart/rating system
- others suggestions are welcome-ask first, though
- long answer (at least a paragraph)
- At least twelve questions
- three questions must be self-evaluative
- four questions must relate to group members' performances
- two question should address larger issues/group concerns OR suggest modifications for future group work
- three questions must be self-evaluative
- At least nine *original* questions. In short, you may use some recycled questions from in-class examples, but the majority have to be made up by you alone. Feel free to borrow various question formats for these nine questions, but be sure the content is your own.
Finally, you will need to include a letter of transmittal (~3 paragraphs) explaining your rational for the evaluative form. It will need to adhere to the genre and answer the following questions:
- What team member qualities did you emphasize and why?
- What ethical (and pragmatic) dilemmas did you encounter while designing this form?
- From a managerial perspective, what is the purpose of such evaluative forms? Do you think they really work?
Evaluative Standards:
- Completeness -have you included all of the required information/types of questions?
- Audience Adaptation/Document Design -Have you made your evaluative form easy to use? Have you employed design elements consciously and with your audience in mind?
- Rhetorical Situation -Does your document provide a clear sense of the team member qualities you value as a manager or participant? Does your memo explain your rational coherently, efficiently and eloquently? Have you considered the ethical issues/problems inherent in evaluative documents?
**Please Remember: You must complete your own evaluative form and turn in your draft, final draft and completed form on the final day of class.
Writing Procedural Instructions
Write a set of instructions for performing a task with which you are very familiar. Write the instructions for readers that have never performed the task before, but who may have rudimentary knowledge of the topic area. Key: you are an expert writing to a novice audience. In order to avoid undertaking a task that is overly complex (or overly simple), you must obtain my approval for the task by writing a plan describing the task and the intended audience.
You must choose a task carefully. First, you must choose a task at an appropriate level of difficulty. Some tasks are too easy to need detailed instructions and others are so complex that they can only be described with a full-scale manual. Second, you must choose a task that can be performed conveniently on campus. A selection of instructions from this class will be tested on real readers in Assignment #4. The restrictions on task selection are spelled out in more detail below.
Constraints on your choice of task:
- The task may involve a device: assembling it, operating it, or fixing it. Or the task may involve some process. You may choose the task from a hobby, a previous (or present) job, or some skill you've acquired in school. Examples of tasks are included on the next page.
- The device or process should have discrete parts that are fairly easy to name and refer to. Avoid "non-componential" tasks: tying a tie, serving a tennis ball, or driving a stick shift.
- The task should take NO LESS THAN 10 AND NO MORE THAN 20 MINUTES to perform.
- The task should be one that can conveniently be performed on campus or at your workplace. You should have the necessary materials at hand while you are writing the instructions; it should be possible to find appropriate readers to carry out your instructions and carrying out the instructions should not be time-consuming, dangerous, or expensive.
NOTE: You may choose a task for which a set of instructions is already available and revise the instructions. In this case, you must discuss the existing instructions in your plan to convince me that you are taking on a challenging revision task. Either you must argue that the existing instructions are seriously inadequate, or you must plan to revise the instructions for a significantly different audience.
Requirements for the plan:
You must submit a plan for my approval that answers the following questions:
- What device or process are your instructions for?
- What kind of readers will you write for? What do you assume they already know about the task? When and why do you expect them to use these instructions?
- Why are the instructions necessary for this task?
- Are there already instructions for this task? If so, attach a copy of at least one page. What's wrong with these instructions? How will your instructions differ significantly from the existing set?
Requirements for the instructions:
Writing Process: In order to create a really good set of instructions, you may need to gather more information about the task. Carry out the task yourself as self-consciously as possible. To find more information or to locate existing instructions to revise, look in the library (you can find entries for manuals and instructions using LIAS). Talk to other people who know how to perform the task and ask them to comment on the existing instructions or on common mistakes that anxious readers always make.
Content and Format: The instructions should follow the general format illustrated in the samples with modifications as required for your rhetorical situation. In general, your instructions should begin clearly by stating what the instructions are for, who should use them, and why. There should be an overview of the procedure. The steps should represent a logical division of actions. The steps should be clearly expressed (as imperative actions and results) and clearly laid out. The instructions should help the reader to check that the procedure was completed successfully and direct the reader to more information, as appropriate.
Completeness, Accuracy, and Clarity: The instructions should contain sufficient information expressed at the appropriate level of detail and with appropriate terminology for your reader to carry them out successfully without additional instruction.
Audience Address: As described above, you must specify what kind of readers should be using these instructions and what you expect them to know. You should address your audience directly (i.e., using second person) and use a tone appropriate to the rhetorical situation.
Visual design: The instructions should employ visual as well as verbal communication. You must include at least one illustration or graphic aid, but you may rely much more heavily than this on figures if they are the most effective means of expression (note: if you make use of pictures or graphics from other sources, be sure to acknowledge the source). In addition, your instructions should use visual cues for increased accessibility, such as headings, numbering, white space and typeface.
User-Test Report (Commissioned Assignment):
Now that you have written the instructions for 4-H, you will test them to see how effective they are and determine how best to revise them. You (or a delegate or delegates from the group) will be visiting a 4-H group where students will try out your materials. Your job is to observe and record very carefully how the instructions work and where problems arise.
TECHNIQUES
How to conduct a user-test: The basic technique is to observe a user trying to follow the instructions-without offering any assistance. You may employ any or all of the following techniques to measure users' success, or even design your own technique (discuss this as a group):
- Record their success or failure at completing individual steps/stages.
- Take notes on their verbal comments or any problems you observe as they read and follow the instructions.
- Distribute a questionnaire/survey/quiz, asking questions specifically designed to illicit the information you're after. (formal)
- Discuss the instructions (and perhaps the test) with the participants after the tests are complete. (informal)
- Time users on certain steps or the procedure overall, taking into consideration the meaningfulness of "time" as a criterion.
RHETORICAL CONSIDERATIONS
Audience: Jan and I are the audience for this report. We have commissioned you to write and test the instructions. In this document, explain what areas of the instructions need improvement, seeking our go-ahead to revise as you specify.
Opening: Your report should open with a standard introduction that overviews the context (the problem situation and your purpose for writing), the scope of your activities (your methods) and your news (results). Finally, to make the report accessible, forecast its organization.
Body: The body should state the objectives of the study, describe and justify the testing methods you used, report the results of the test, analyze the results, and use the analysis to support a detailed account of what needs to be changed.
Closing: Your report should close by reminding the readers of the importance of solving the problems and summarizing your findings and recommendations.
Appendices: You should include exact copies of the instructions you tested and any materials you used during the test.
Format/Style: Your report should be clearly organized and accessible. You should use headings, overviews, and other techniques to reveal your organization. Your prose should be concise and active (it's ok to use personal pronouns in this report). Your final draft should be free of grammatical and proofreading errors.
Length: Shoot for 5-6 single-spaced pages, excluding tables, figures, and appendices.
Web Site Analysis
For Assignment 5, you will analyze a Web site. Your analysis should demonstrate that you understand the basic design principles discussed in Lynch and Horton's online Yale Web Style Guide and in the textbook. Although there is not enough time in this course to ask you to design your own site, a useful first step in learning how to communicate via the Web is to study in a systematic way what others have done. You can then model those practices that seem to be productive and avoid those that don't. The process you will follow in this assignment is relatively straightforward. I will provide you with an outline of analysis points that roughly mirrors the organization of the Yale Web Style Guide. You will study a Web site and then determine how well it relies (or doesn't) on the best practices discussed by Lynch and Horton in their text. Your audience will be the designers of the website you've chosen.
There are at least three tricks to this assignment:
- Be concrete in your analysis. That is, use examples from the site as you make your key points.
- Be sure to analyze and not just describe the site. This will require you to evaluate--and pass judgment on--both content and design.
- Be sure your analysis is well organized. You can modify the structure that I provide below, but you should have a good reason for using an alternative scheme.
Your analysis should be 1000-1250 words in length (4-5 pages). Therefore, you must be as concise as possible. However, don't mistake brevity for superficiality. I'm looking for a high-quality analysis that shows you can look at Web site design with a critical eye.
Web Site Selection First, choose a Web site to analyze. The site can be commercial, educational, or governmental. The main thing is that it interests you for professional reasons. For example, if you're interested in intellectual property issues, find a site on the subject. Want to go to law school? Pick a site that describes a program you're considering. Want to read more about Web design? There are plenty of sites on that topic. But you need to be careful in selecting a site because the site you choose will help shape your analysis. Here are some considerations to help with site selection:
- Consider the nature of the site: pick a site that you are interested in for professional reasons.
- Consider your knowledge level of the topic covered on the site. In general, the more you know about the topic, the easier it will be for you to analyze the effectiveness of the site. Don't choose a topic you know nothing about, because you'll have trouble with your analysis.
- Consider the content of the site. You want to analyze relatively "mature" and stable content.
- Consider the owner of the site. The owner should be identifiable, professional, and reputable.
- Consider the size of the site. A highly structured site with just a few pages probably won't provide you with enough things to analyze. On the other hand, you would have a very hard time trying to analyze a huge site in 4-5 pages.
Given these considerations, here are examples of sites that could work well for this assignment. It will be helpful for you to look at these in order to stimulate your thinking.
- Penn State University Libraries
- Fitness Online
- Student World Traveler
- Canadian Museum of Nature
- Investing Online
- American Society of Civil Engineers
Analysis Points: You should cover all of the following questions in your analysis. You can use the headings provided below to help organize your own analysis.
Rhetorical Design
- Who is the primary audience for the site? Is there a secondary audience?
- What is the main purpose of the site (e.g., to inform, educate, persuade, and/or entertain)?
- Are there multiple purposes?
- What is the context for the site? That is, what is the mission of the organization sponsoring the site?
Interface Design
- What overall metaphor informs the design of the site? Does it seem to work for the audience?
- Discuss the navigation structure. Are the navigation aids clear?
- Does the site include basic document elements? I'm referring to the Who-What-When- Where issues listed in Lynch and Horton. Are they helpful?
- Is the interface design simple, consistent, and functional?
- Does the interface provide sufficient feedback and dialog?
Site Design
- Does the site organize information effectively and logically?
- What structures does it employ (e.g., sequences, grids, hierarchies, webs)?
- Does the chunking strategy aid navigation and use?
- Comment on the home (main) page. What design strategies are used here? Do they seem to work for the audience?
- Does the site rely on tables of contents, indexes, site maps, "what's new" pages, search features, or FAQ pages? Are additional features such as these needed to clarify the overall site design?
- Does the site accommodate disabled users?
Page Design
- Analyze the layout of pages. Can you discern a grid or grids that structure the pages in the site?
- Do the pages reveal a strong, consistent visual hierarchy?
- What page elements do the designers rely on (e.g., tables, headers and footers)? Are their missing elements that could be useful to the audience?
- Does the site employ frames? If so, comment on the issues of flexibility, functionality, interactivity, and aesthetics as discussed by Lynch and Horton.
Typography
- Discuss the characteristics of the type used on the Web site. Is it effective? Why or why not?
- Be sure to cover legibility, alignment, white space, and emphasis markers.
Editorial Style
- Analyze the writing style on the Web site. How would you characterize it?
- Is the prose organized for protocols of reading on the Web (e.g., skimming and scanning)?
- Does the site use titles and subtitles (as all technical communication should)?
- In what ways are links integrated with prose?
Graphics
- Analyze the graphics on the site. What types of graphics are used?
- Do the graphics have clear rhetorical purposes, or are they just ornamental?
- Do the graphics load quickly?
Multimedia
- Does the site use audio, video, or animation? If so, are these elements used effectively? What rhetorical purposes do they serve?
- How well do these elements perform on your machine? That is, do they load quickly? Did you have to install software to look at them?
Overall Impressions
- What did you like best about the site?
- What did you like least about the site?
- Given your experiences on the Web, how would you rate the site? Excellent? Average? Poor?
Format
Your analysis should include a title page with the following information: Your name, the title of the Web site, its URL, and the publisher/owner of the site. The analysis should run about 4-5 double-spaced pages in 12-point type (1000-1250 words). Number pages, use a running header, and use headings and possibly subheadings.
Evaluation criteria: I will evaluate the analyses according to these criteria
- Completeness: The analysis addresses all of the analysis points listed above.
- Organization: The analysis is well organized. It has a clear structure supported by headings.
- Support: The analysis is concrete in that it uses examples from the Web site to support major points.
- Interpretation: The analysis interprets, analyzes, passes judgment--it does not just describe.
- Audience Adaptation: The analysis shows sensitivity to the designers of the site.
- Style: The analysis is well written. Topic sentences are clear.
- AND: The analysis demonstrates that you have learned about basic design principles for creating Web sites.
Library-Internet Guide
Each profession has its own unique "discourse community," or means by which members of that profession both share and increase the knowledge of that profession. In order to locate the mechanisms of communication used by your profession's discourse community, and to help novices in your field more easily find and use those mechanisms of communication, you will be writing a Library/Internet Guide to resources used by members of your profession. The audience for your guide will be other students in your major. Organize and format this information so that other students may use the PSU library and the Internet for research by following your guide.
Note that this is a collaborative assignment. You will be grouped up with other students in your major. If there are no other students in your major, you will work alone but will not be expected to do the same amount of work that groups will do. People working alone should see me for a revised assignment.
Objectives
- To become familiar with on-line searching in order to locate specific and good resources used by professionals in your field;
- To identify possible sources of information for your literature review and other assignments in the course;
- To make decisions about organization, format, and style as a means of creating usable documents for readers;
- To develop skills with writing abstracts.
General Directions
Your Guide should include the following components:
- A title page
- An introduction - Your introduction should provide information about your guide and its use, including
- What's in the guide (contents/scope);
- Who the guide is for (audience/purpose);
- What the guide assumes readers know;
- How the guide is organized for use; and
- Tips for using the guide
- What's in the guide (contents/scope);
- A table of contents
- A listing of the resources that you identify (see "Resources to Identify in the Guide," below).
For each resource that you identify, provide identifying information (title, journal, URL etc.). Also, describe the resource in an abstract so that readers will understand its general function and its specific scope. For example, your paragraph on the index should tell the reader both the purpose of the index (number 1 under "Resources to Identify in the Guide," below ) and the range and dates of periodicals covered.
In writing the abstracts, assume that readers will ask these four questions:
- What is this?
- What is in it (contents, scope)?
- How is that information relevant and useful for someone in my field?
- Are there any particular tips for using the resource efficiently?
Resources to Identify in the Guide
1. Identify at least one print and one on-line index to the periodical literature in your major field.
2. Identify resources in your field from at least four of the following categories:
specialized dictionary
biographical reference
subject guide to the literature
abstract
encyclopedia
handbook
bibliography
3. Identify at least one printed and one on-line professional journal in your field and cite its specific strengths and uses.
4. Describe the Monthly Catalog of United States Government Publications (on-line) and its uses.
Use the Monthly Catalog to locate a report published by a government agency that relates to your major field. (The report will serve as an example of what the catalog can identify.) As you describe the Monthly Catalog in your Library-Internet Guide, be sure to provide the bibliographic data for the report you locate as an example and include a 1-2 sentence description of the report.
5. Describe the Statistical Abstract of the United States as a reference tool.
Use the U.S. Census Bureau version of the Statistical Abstract rather than the version available through LIAS, which can be difficult to navigate. Explain how to use the abstracts by using an example of a subject to investigate that is relevant to your field.
6. Locate a style guide or publication manual for your field.
Include information illustrating the appropriate documentation style for a periodical article, for a book, and for a website. Note: Many (though not all) style guides are available on-line. Some may be accessed from parent organization Web sites; others are available through research library sites. Examples of style guides for different fields include the following:
- Life Sciences (biology, agriculture): Council of Biology Editors Style Manual (recently changed to the Council of Science Editors, though the old title is frequently used).
- Chemistry: ACS Style Guide
- Mathematics: AMS Author Handbook
- Physical Sciences: American National Standards for the Preparation of Scientific Papers for Written or Oral Presentation.
- Engineering: check the "notes to contributors" of the best academic journal in your field, and follow the documentation style of that journal.
- Technical Writing: Chicago Manual of Style, author-year style.
- Social Science, Business: Publication Manual of the American Psychological Association.
- Humanities: MLA Handbook or Chicago Manual of Style
7. Identify Internet and World Wide Web sites that are relevant to your discipline.
Choose at least five from the following categories of Internet/Web information (or propose other relevant categories of information to me):
- Directory of information sources
- Sample reports, documents, research studies
- Government documents
- Patents and intellectual property
- Potential employers and job search services
- News services
- Discussion groups, chat rooms
- Information on professional associations
Evaluation criteria
- Content - the guide is complete (includes all the information requested), and the sources identified are current and significant.
- Format/Organization - readers will be able to find the information they need. Related materials are grouped. The guide is "usable."
- Style - abstracts give specific information in efficient sentences.
- Audience Adaptation - the guide offers explanatory material or instructions where necessary to help the designated audience conduct their research.
- Mechanics - Spelling, grammar, punctuation, etc. are correct.
Library/Internet Guide Audience Analysis Worksheet
To write an effective technical document, you need to have a clear sense of who the document's readers will be, what they will be expecting to get from your document, and the real-life situations in which they will be reading or using your document. This worksheet is designed to help you establish a more concrete portrait of your readers for the Library/Internet Guide. NOTE: Please answer these questions on a separate sheet of paper. They will be collected with your final draft of the Library/Internet Guide, so answer them thoroughly and carefully.
- Describe in detail the audience who will actually be reading and using your guide. Will it be simple and homogenous, or complex and heterogeneous? How will that affect how you write the guide?
- What problem of your audience are you trying to solve by writing the Library/Internet Guide? What is the primary role of your audience-are they transmitters, action takers, advisors, decision makers, learners, or implementers? How will this affect how you write the guide-your tone, content, etc.? That is, what kind of role does your audience place you in as a writer?
- How motivated is your audience to read the Library/Internet Guide? If they're not motivated, what strategies could you use in writing the guide to make them more motivated or to convince them of the importance of the guide?
- How familiar is your audience with the material in the Library/Internet Guide? Do you need to supply any background information or explanation of the terms or technologies used in the guide? What does your audience already know or have experience in that you can build on?
- Under what conditions or circumstances would your audience be reading or using the Library/Internet Guide? How will this affect the content and organization of the guide?
Writing for Identifiable Audiences
- Answer the following questions about audiences:
- Who are the real and possible audiences of this communication? If there are several audiences, how are they related?
- After reading this document, how should these audiences be different or think differently? What new information or perspectives should they have? What should they be able to do as a result of reading or using the document?
- What further information would the audiences need in order to affect this change?
- Use the following strategies to clarify the needs of various audiences:
- Make a list of the audiences you have identified for the document. Under each audience, make a list of their specialized needs. Consider the following factors:
- Functional responsibilities/task responsibilities of audiences
- Experience with task/organization
- Level of expertise and education
- Organizational role/job classification
- Working environment, task environment
- Technology support/knowledge
- Motivation/attitude
- Preferences/learning styles
- From the list you have made, choose that person or group of people you consider to be the primary audience for the document. Write a paragraph on the major purposes you think that the audiences might have for reading the document. Write from the perspective of the audience.
- Make a list of the audiences you have identified for the document. Under each audience, make a list of their specialized needs. Consider the following factors:
Review questions: Draft of abstracts
Are the draft abstracts complete? Do they include all identifying information (title, call number, location, URL etc.)? Does the guide include this identifying information in a consistent way? Can you offer suggestions for design revisions so that this basic information is readily accessible?
Do the draft abstracts describe the resources so that readers will understand both their general function and their specific scope? (For example, your abstract on the index should tell both the purpose of the index and the range and dates of periodicals covered.) If not, what information is needed to complete the abstract? Ask yourself: what do I know about this source, what am I still wondering about?
Do the draft abstracts answer all four of the following questions sufficiently:
- What is this?
- What is in it (contents, scope)?
- How is that information relevant and useful for someone in my field?
- Are there any particular tips for using the resource efficiently?
Be sure to consider the final questions carefully-can you tell, from the abstract alone whether this source will be useful or not? What evaluative evidence is given to indicate that the source is current, useful, relevant, and significant to the field?
Do the abstracts include a sufficient amount of detail? Can the writer expand the abstracts in any way? (Remember detailed statements are better than general ones.) Can you make suggestions for cutting extraneous information and highlighting more relevant info?
Approved Texts
- Anderson, Paul. Technical Communication: A Reader-Centered Approach. Harcourt Brace Jovanovich, 4th edition.
- Houp, Kenneth W. et al. Reporting Technical Information. Oxford University Press, 10th edition.
- Killingsworth, M. Jimmie. Information in Action: A Guide to Technical Communication. Allyn and Bacon, 1996.
- Lannon, John. Technical Communication. Addison Wesley Longman, 9th edition, 2000 (0-321-08979-0)
- Lay, Mary et al. Technical Communication. 2nd Edition Irwin/McGraw Hill, 2000 (0-256-22058-1).
- Markel, Mike. Technical Communication. 7th edition. Bedford/St. Martin's Press, 2004 (0-312-40338-0).
- Schall, Joe. Style for Students: Effective Technical Writing in the Information Age. Outernet Publishing, 12/2001 (1-58175-272-5).
- Sims, Brenda. Technical Communication for Readers and Writers 2nd edition. Houghton Mifflin, 2003 (0-618-22173-5).
(Note: According to department policy, instructors may use other textbooks, with the permission of the Director of Composition Programs.)
- To become familiar with on-line searching in order to locate specific and good resources used by professionals in your field;
- What team member qualities did you emphasize and why?
