Longman / Prentice Hall

English

Browse available resources for Technical Communication:



Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication), 2/E
Thomas T. Barker, Texas Tech University

ISBN-10: 0321103289
ISBN-13: 9780321103284

Publisher: Longman
Copyright: 2003
Format: Paper; 496 pp
Published: 10/01/2002

Suggested retail price: $86.60
Buy from myPearsonStore

Part of the Allyn & Bacon series in technical communication, Writing Software Documentation features a step-by-step strategy to writing and describing procedures.

This task-oriented book is designed to support both college students taking a course and professionals working in the field. Teaching apparatus includes complete programs for students to work on and a full set of project tracking forms, as well as a broad range of examples including Windows-style pages and screens and award-winning examples from STC competitions.

  • Offers a step-by-step process for analyzing users and designing task-oriented documents.
  • Checklists in each chapter provide convenient summaries for keeping organized and on track.
  • Abundant exercise work helps students develop the skills they need to write good documentation.
  • Flexible chapter organization allows for selective reading depending on whether the reader is doing a specific project or reading to understand broader concepts.
  • Examples in each chapter offer specific and detailed explorations of document elements relevant to the chapter topic.
  • Guidelines sections in each chapter break sometimes complex tasks into discrete steps.
  • Practice sections in each chapter offer cases for application of concepts learned and help provide discussion material.
  • Extensive instructor's manual includes chapter quizzes, overhead masters, additional exercises, and sample syllabi.
  • Re-organized and simplified approach now emphasizes tutorials, procedures, and reference manuals in a more concise, and accessible style throughout.
  • New coverage of Web-based design techniques (HTML, JavaScript, multi-media) and an increased focus on writing online documents (especially HTML and help documents).
  • Complete set of planning forms for use with a companion help authoring tool.
  • Now includes a new section on writing for multicultural and multilingual users.
  • New emphasis on techniques for addressing complex user tasks.
  • Expanded treatment of editing for design and illustrations.
  • Improved coverage of indexing and keyword searching.
  • Updated, award-winning examples.

Each chapter begins with “Examples,” and “Guidelines,” and concludes “Glossary,” “Checklist,” and “Practice/Problem Solving”.

1. Understanding Task Orientation.

1. Emphasize Problem-Solving.

2. Provide Task-Oriented Organization.

3. Encourage User Control of Information.

4. Orient Pages Semantically.

5. Facilitate Both Routine and Complex Tasks.

6. Design for Users.

7. Facilitate Communication Tasks.

8. Conducting Usability Tests.

9. Support Cognitive Processing.



Discussion.

The Principles of Software Documentation.

A Definition of Task Orientation.

The Theory Behind Task Orientation.

Tutorial Documentation.

Procedural Documentation.

Reference Documentation.

The Processes of Software Documentation.

I. The Forms of Software Documentation.

2. Writing to Teach—Tutorials.

1. Identify User Actions You Need to Support.

2. State Objectives as Real-World Performance.

3. Choose the Right Type of Tutorial.

4. Present Skills in a Logical, Cumulative Structure.

5. Offer Highly Specific Instructions.

6. Give Practice and Feedback at Each Skill Level.

7. Test Your Tutorial.

Discussion.

Designing Tutorials.

Tutorial Users Need Special Care.

The Elaborative Approach.

The Minimalist Approach.

3. Writing to Guide—Procedures.

1. Relate the Task to Meaningful Workplace Activities.

2. Determine How Much Information Your User Needs.

3. Choose the Appropriate Procedural Format.

4. Follow a Rhythm of Exposition.

5. Test All Procedures for Accuracy.

Discussion.

What Constitutes a Procedure?

How Does a Procedure Work?

4. Writing to Support—Reference.

1. Choose the Right Form of Reference.

2. Decide What to Include.

3. Establish Pattern.

4. Organize the Reference Section.

5. Show How to Use the Reference Information.

Discussion.

Understanding the Reference User.

Understanding a Reference Entry.

II. The Process of Software Documentation.

5. Analyzing Your Users.

1. Choose Users Carefully.

2. Anticipate Transfer of Learning: Study Before and After Tasks.

3. Research Professional Behaviors.

4. Write User Cases.

5. Plan Interviews Carefully.

6. Involve Users in All Phases of the Project.

7. Identify Document Goals.

8. Tie the User Analysis to Documentation Features.

Discussion

What Does Use Mean?

What You Want to Know About Users.

Tasks the User Will Perform with the Program.

The User's Informational Needs.

The User's Work Motivations.

Range of Computer Experience: Novice, Experienced, Expert.

Extent of Knowledge of Subject Matter of the Program.

The Workplace Environment: User Communities.

Users' Learning Preferences.

Usage Patterns: Regular, Casual, Intermittent.

6. Planning and Writing Your Documents.

1. Start the Project.

2. Design the Documents.

3. Perform the User Analysis.

4. Plan the Documentation Project.

5. Write the Alpha Draft.

6. Conduct Reviews and Tests.

7. Revise and Edit.

8. Write a Final Draft.

9. Conduct a Field Evaluation.

Discussion.

Team Structures.

Kinds of Development Documents.

Processes.

The Documentation Plan.

Reviewing the Documentation Plan.

An Outline for a Documentation Plan.

7. Getting Useful Reviews.

1. Review the Document Objectives from the Documentation Plan.

2. Determine the Type of Review Needed.

3. Establish a Review Schedule.

4. Plan the Reviews.

5. Write a Cover Letter with Questions for Reviewers.

6. Prepare Feedback Materials for Reviewers.

Discussion.

Reviewing Differs from Testing.

Reviewing Differs from Editing.

The Purpose of Reviews.

Reviewing throughout the Documentation Process.

Reviewers as Partners.

Negotiate Conflict Diplomatically.

Do a User Walkthrough.

Review Form.

8. Conducting Usability Tests.

1. Decide When to Test.

2. Select the Test Points.

3. Choose the Type of Test.

4. Set Performances and Learning Objectives.

5. Select Testers and Evaluators.

6. Prepare the Test Materials.

7. Set Up the Test Environment.

8. Record Information Accurately.

9. Interpret the Data.

10. Incorporate the Feedback.

11. Tie Testing to Document Goals.

12. Do Some Pilot Testing.

13. Make the Test Objective.

Discussion

What Is Testing?

The Importance of User Testing as Part of User-Driven Design.

The Advantages of Field Testing.

Methods of Field Testing that Emphasize Task Issues.

How to Interpret Test Data.

9. Editing and Fine Tuning.

1. Establish Project Guidelines.

2. Understand the Types of Editing.

3. Plan Your Editing Tasks.

4. Develop the Appropriate Editing Forms.

5. Conduct Editing Sessions.

Discussion.

Editing Graphics.

Writing Versus Editing.

Writing for Cross-Cultural Readers.

Editing for Translation.

How Do You Know What's Correct?

Take a Constructive Attitude.

Consult Standard Style Guides.

III. The Tools of Software Documentation.

10. Designing for Task Orientation.

1. Create a Table of Contents.

2. Match the User Analysis with Information Design Strategies.

3. Acknowledge Production Constraints in Document Design.

4. Test and Review the Design.

5. Follow a Design Process for Online Help.

Discussion.

The Design Problem.

Accommodating Groups of Users.

Matching the User's Problem—Solving Methods.

A Design Guide for Printed Documentation.

Navigation.

Cross—References.

Running Headers and Footers.

Solutions to the Design Problem for Online Documentation.

11. Laying Out Pages and Screens.

1. Review the User Analysis.

2. Create Page Grids.

3. Define the Page Grid Using Styles.

4. Draw Thumbnail Sketches.

5. Set Up Pages and Styles in Your Word Processor.

6. Determine the Layout of Help Documents.

Discussion.

Designing Communication Spaces.

How to Look at Pages and Screens.

Common Page Designs.

The Elements of Page Design.

Common Screen Designs.

The Elements of Screen Design.

Designing Type.

Helping People Recognize Words.

Design Advice.

Building Patterns with Type.

The Idea of Body Text.

Non-Body Text.

12. Getting the Language Right.

1. Write About Actions Rather than Functions.

2. Revise for the Active Voice.

3. Revise to Keep Writing Simple.

4. Revise to Build Parallel Structures.

5. Add Operational Overviews.

Discussion.

How Do We Process Language?

Performance-Oriented Language.

How Do We Remember and Learn?

Style Problems in Software Documentation.

13. Using Graphics Effectively.

1. Identify Needs for Graphics by Your Users.

2. Set Graphics Styles.

3. Revise and Edit.

4. Revise for Typography.

Discussion.

Showing How Tools Apply to the Workplace.

Show Results of Software Operations.

Present Overviews to Integrate Software with Workplace Activities.

Suggest Functions and Uses.

Make the Abstract Concrete Through Metaphors.

14. Designing Indexes.

1. Plan Your Indexing Strategy.

2. Decide What to Index.

3. Identify the Level of Detail.

4. Decide on Phrasing and Format.

5. Edit and Proofread.

Discussion.

Why an Index?

Online Index Versus Print Index Versus Keywords.

Automatic Indexing Software Programs.

Indexing with Search Engines.

Tools for Indexers.

Endnotes.

Credits.

Index.

For Software Documentation


For Technical Communication - Advanced


Pearson Higher Education offers special pricing when you choose to package your text with other student resources. If you're interested in creating a cost-saving package for your students, contact your Pearson Higher Education representative for pricing and ordering information.

This title is a member of the Technical Communication, which also contains the titles below . You can also visit the Technical Communication page.

    Written by two highly experienced teachers in the field of document design, Designing Visual Language offers useful strategies and tools for document design of all types. A chief goal is to enable students to extend to visual design the rhetorical approach they assimilate in writing and editing courses. The text focuses on the kinds of situations and practical documents that occur in the workplace and blends this focus with a rhetorical approach that ties design to the audience, purpose, and context of messages.

  • 0205200222Designing Visual Language: Strategies for Professional Communicators (Part of the Allyn & Bacon Series in Technical Communication)
    Kostelnick, Roberts & Dragga
    © 1998 | Longman | Paper; 455 pages | Instock
    ISBN-10: 0205200222 | ISBN-13: 9780205200221
    Brief Description | Buy from myPearsonStore

    • This book deals with ethics and value systems as they relate to technical and scientific discourse. While it covers several traditional ethical theories from classical to contemporary times, it also emphasizes that ethics is a personal matter of judgment. The book shows students how to become involved with thinking about and applying these theories to their own discourse. The fact that there are no easy answers to ethical questions is emphasized.

    Issues that are covered include how and why information is obtained and how it will be used; how the meaning of technical terms shift with the value perspectives behind them; and how science and technology can be used to put forth questionable values or to serve values not apparent in the discourse.

  • 0205274625Ethics in Technical Communication (Part of the Allyn & Bacon Series in Technical Communication)
    Dombrowski & Dragga
    © 2000 | Longman | Paper; 258 pages | Instock
    ISBN-10: 0205274625 | ISBN-13: 9780205274628
    Brief Description | Buy from myPearsonStore

    • Global Contexts offers a series of case studies about real and fictitious situations that allow students to understand the issues surrounding international and cross-cultural technical communication.

    Cases are individually authored and have been created by many of the leading authorities in the field of international technical communication. The text is intended to help graduate and undergraduate students understand the context of and issues involved in writing for international audiences, as it has become increasingly common in the evolving global marketplace to address such audiences, especially in technical fields.

  • 0205286828Global Contexts: Case Studies in International Technical Communication (Part of the Allyn & Bacon Series in Technical Communication)
    Bosley
    © 2001 | Longman | Paper; 216 pages | Instock
    ISBN-10: 0205286828 | ISBN-13: 9780205286829
    Brief Description | Buy from myPearsonStore

    • This guide teaches students and professionals a systematic process for researching, designing, writing, and submitting successful grant-seeking proposals.

    Focusing on proposals submitted for government, foundation, and corporation funding, Grant Seeking in an Electronic Age leads the reader through a six-step grant-seeking process, from researching potential funders, to designing, writing and submitting a proposal that follows the funder's guidelines. Grounded in theory, but rooted in successful practice, it teaches students what really works—a third of students who submit proposals based on this text's approach get funded within a year. The text's guided discovery process provides a useful framework for novice writers while its thinking-planning exercises offer useful ways of organizing information and discovering what still need to be researched.

  • 032116007XGrant Seeking in an Electronic Age (Part of the Allyn & Bacon Series in Technical Communication)
    Mikelonis, Betsinger & Kampf
    © 2004 | Longman | Paper; 512 pages | Instock
    ISBN-10: 032116007X | ISBN-13: 9780321160072
    Brief Description | Buy from myPearsonStore

    • Management Principles and Practices for Technical Communicators presents theory and practice in a manner designed to help practicing managers, graduate students, and advanced undergraduates.

    The book covers areas of management that are specific to technical communication groups, focusing on how such groups should position themselves within larger organizations and how they should interact and communicate with other groups. These tasks and others are consistently informed by the book's four main premises: that technical communication managers need to conceptualize what they do, that they must understand and participate in the overall goals of their larger organizations, that technical communicators are developers who create products and services and not merely support, and that technical communication managers must educate peers and upper management to the value that their groups add to the development process.

  • 0321165233Management Principles and Practices for Technical Communicators (Part of the Allyn & Bacon Series in Technical Communication)
    Dicks
    © 2004 | Longman | Paper; 272 pages | Instock
    ISBN-10: 0321165233 | ISBN-13: 9780321165237
    Brief Description | Buy from myPearsonStore

    • Oral Presentations for Technical Communication provides what most technical communication textbooks lack: clear, accessible instruction on speaking. This book helps students and professionals master public speaking in a technical or scientific environment, whether it be through traditional presentations with whiteboards and flipcharts or presentations with computer software such as PowerPoint. Unlike most general speech texts, which include examples from various disciplines, Oral Presentations uses specific examples from the fields of science and technology and shows how skilled technical communicators make complex information accessible to non-technical audiences.

    The first three parts of the book focus on basic skills and concepts, including four basic types of presentations relevant to technical communication. The last two parts introduce more advanced topics, such as legal, privacy, and censorship issues, and the changing nature of presentations in the digital age.

  • 0205294154Oral Presentations for Technical Communication: (Part of the Allyn & Bacon Series in Technical Communication)
    Gurak & Dragga
    © 2000 | Longman | Paper; 263 pages | Instock
    ISBN-10: 0205294154 | ISBN-13: 9780205294152
    URL: http://www.abacon.com/gurak
    Brief Description | Buy from myPearsonStore

    • This is a conceptually rich textbook that teaches Web design skills and offers practical guidance within a coherent framework of information-design principles and hypertext theory.

    The authors believe website design should be taught as a substantive body of knowledge, an application of rhetoric to a new non-linear medium. This book offers students a great deal of practical, mainstream design guidance—as much as can be found in any trade book. But in contrast to trade books, Principles of Web Design offers a coherent, evolving framework of ideas.

  • 0205302912Principles of Web Design (Part of the Allyn & Bacon Series in Technical Communication)
    Farkas, Farkas & Dragga
    © 2002 | Longman | Paper; 400 pages | Instock
    ISBN-10: 0205302912 | ISBN-13: 9780205302918
    Brief Description | Buy from myPearsonStore

    • This market-leading text has been thoroughly revised to reflect recent changes in technology, workplace practices and the global marketplace. The book progresses from concepts and basic copyediting to comprehensive editing, management and production issues. Coverage now includes a new chapter on client projects.

    Technical Editing takes a comprehensive approach to editing and defining editorial responsibility in terms of information design and the overall effectiveness of a document in helping readers understand and complete tasks. Expanding the concept of editing from a narrow focus on sentence-level revisions for correctness, this book encourages students to think about the effects of word choices, sentences, organization and design. Students learn that the measure of a “good” document is in part outside that document, in the document’s “match” to the users' needs and the author's goals.

    The textbook with its supplementary Web site and instructor’s manual offers a complete editing course, including materials for daily workshops and discussion and longer documents for graded assignments. In a password-protected portion of the Web site, instructors can also retrieve illustrations of edited versions as well as suggested responses to daily activities. Both focused and flexible, Technical Editing includes assignments carefully crafted to develop specific editing competencies and modular chapters that allow instructors to adapt the text to meet their own course goals and methods. 
  • 032133082XTechnical Editing, 4/E
    Rude
    © 2006 | Longman | Paper; 480 pages | Instock
    ISBN-10: 032133082X | ISBN-13: 9780321330826
    Brief Description | Buy from myPearsonStore

    • Part of the new Allyn & Bacon Series in Technical Communication, Technical Writing Style is equally appropriate as a core text or as a supplement. This text offers the most current and comprehensive instruction available in achieving an effective style in technical docu- ments. It shows that technical prose style varies from the highly formal to the colloquial, from the pretentious to the plain, and it demonstrates the many stylistic strategies writers should consider for every technical document they write.

    Among the major topics included are: style and technical writing style; audiences and discourse communities; persuasion through style; diction; style in sentences and paragraphs; tone; bias; ethics; and editing for style. Throughout, engaging real-world case studies and numerous examples reinforce the author's discussion of effective and ineffective technical prose styles.

  • 0205197221Technical Writing Style (Part of the Allyn & Bacon Series in Technical Communication)
    Jones & Dragga
    © 1998 | Longman | Paper; 302 pages | Instock
    ISBN-10: 0205197221 | ISBN-13: 9780205197224
    Brief Description | Buy from myPearsonStore

    • Built on a solid foundation of current research in the field, Carol Barnum's Usability Testing and Research provides a comprehensive, up-to-date perspective in this increasingly important area of technical communication.

    Adopting a practical approach to the field of usability and the techniques for usability testing, this book lays out the subject from beginning to end: starting with definitions of usability, usability testing, and the way in which usability testing fits into a user-centered design process, then progressing through other methods of gathering data, as well as methods for learning about users, tasks, and environments. Following a chapter on ways to test throughout product design, the second half of the book focuses on planning, conducting, and reporting the results of usability testing. The last chapter discusses the usability testing of web sites.

  • 0205315194Usability Testing and Research (Part of the Allyn & Bacon Series in Technical Communication)
    Barnum & Dragga
    © 2002 | Longman | Paper; 448 pages | Instock
    ISBN-10: 0205315194 | ISBN-13: 9780205315192
    Brief Description | Buy from myPearsonStore

    • Founded on rhetorical principles guiding the field of technical/business/professional writing, Writing Proposals offers a comprehensive, activity-based approach to proposal and grant proposal development.

     

    Writing Proposals provides readers with a full range of tools needed to develop sound, convincing proposals.  This comprehensive and up-to-date text, takes readers step-by-step through the development process, helping them invent their ideas, organize their materials, write in plain and persuasive styles, and create an effective visual design.

     

    The inclusion of grantwriting expands the range of uses for this book. The second edition offers full coverage of this important subgenre of proposal writing. One of the case studies that runs through the book shows a team of people writing a grant to a private foundation. Readers will find the book very helpful for writing grants to fund research and good causes.

  • 0205583148Writing Proposals, 2/E
    Johnson-Sheehan
    © 2008 | Longman | Paper; 288 pages | Instock
    ISBN-10: 0205583148 | ISBN-13: 9780205583140
    Brief Description | Buy from myPearsonStore

    • Part of the Allyn & Bacon series in technical communication, Writing Software Documentation features a step-by-step strategy to writing and describing procedures.

    This task-oriented book is designed to support both college students taking a course and professionals working in the field. Teaching apparatus includes complete programs for students to work on and a full set of project tracking forms, as well as a broad range of examples including Windows-style pages and screens and award-winning examples from STC competitions.

  • 0321103289Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication), 2/E
    Barker
    © 2003 | Longman | Paper; 496 pages | Instock
    ISBN-10: 0321103289 | ISBN-13: 9780321103284
    Brief Description | Buy from myPearsonStore

    • This is the first collection of narratives by practicing technical communicators telling their own personal stories about the workplace and their lives on and off the job.

    The stories vividly demonstrate the unique power of narrative as a teaching and learning tool. Unlike fabricated cases, these real-life narratives show new and veteran technical writers at work on the job, dealing with tasks, clients, and co-workers, and revealing their insights, values, and attitudes about their work. The stories also show the skills required in the profession and the ethical and other issues raised in the course of the workday.

  • 0205321062Writing a Professional Life: Stories of Technical Communicators On and Off the Job (Part of the Allyn & Bacon Series in Technical Communication)
    Savage, Sullivan & Dragga
    © 2001 | Longman | Paper; 292 pages | Instock
    ISBN-10: 0205321062 | ISBN-13: 9780205321063
    Brief Description | Buy from myPearsonStore

    • Writing for the Government blends experience-based theory with actual workplace applications from a wide range of fields and documents to prepare readers for positions in government.

     

    Taking a rhetorical approach to writing, the authors encourage students to consider every document’s audience, purpose, and cultural context and increase the effectiveness of their communication.  Writing is also presented as a process, particularly collaborative, in which authors have a stake in the outcome.  The purpose is to prepare students to become “adaptable” writers regardless of their job, their agency, or its writing tasks.

  • 0321427017Writing for the Government
    Allison & Williams
    © 2008 | Longman | Paper; 320 pages | Instock
    ISBN-10: 0321427017 | ISBN-13: 9780321427014
    Brief Description | Buy from myPearsonStore

    • Practical, applied, and up-to-the-minute, Writing for the Health Professions teaches students, healthcare professionals, and professional writers the essential skills in medical and health communications.

    Drawing on her extensive experience as a nurse, cardio-pulmonary technician, medical writer, and writing teacher, Barbara Heifferon addresses the communications requirements of the healthcare professions and those who write in these high-tech fields. This comprehensive text covers writing situations and documents common in hospitals, clinics, HMOs, health insurance companies, public health campaigns, and other healthcare environments. Special attention is given to visual and electronic forms of communication, including Web sites and multimedia productions.

  • 0321105273Writing in the Health Professions
    Heifferon
    © 2005 | Longman | Paper; 336 pages | Instock
    ISBN-10: 0321105273 | ISBN-13: 9780321105271
    Brief Description | Buy from myPearsonStore

    • This rhetorical, multi-disciplinary guide teaches the major genres of science writing, including research reports, grant proposals, conference presentations, and a variety of forms of public communication.

    Writing in the Sciences combines a descriptive approach—helping students to recognize distinctive features of common genres in their fields—with a rhetorical focus—helping them to analyze how, why, and for whom texts are created by scientists. Multiple samples from real research cases illustrate a range of scientific disciplines and audiences for scientific research, along with the corresponding differences in focus, arrangement, style, and other rhetorical dimensions. Comparisons among disciplines provide the opportunity for students to identify common conventions in science and investigate variation across fields.

  • 0321112040Writing in the Sciences: Exploring Conventions of Scientific Discourse (Part of the Allyn & Bacon Series in Technical Communication), 2/E
    Penrose & Katz
    © 2004 | Longman | Paper; 464 pages | Instock
    ISBN-10: 0321112040 | ISBN-13: 9780321112040
    Brief Description | Buy from myPearsonStore

Pearson Higher Education offers special pricing when you choose to package your text with other student resources. If you're interested in creating a cost-saving package for your students, browse our available packages below, or contact your Pearson Higher Education representative to create your own package.



Copyright ©2008 Pearson Education. All rights reserved. Legal Notice | Privacy Policy | Permissions