Home > Language, Linguistics & Creative Writing > Linguistics > Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)
5%
Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)

Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)

          
5
4
3
2
1

Out of Stock


Premium quality
Premium quality
Bookswagon upholds the quality by delivering untarnished books. Quality, services and satisfaction are everything for us!
Easy Return
Easy return
Not satisfied with this product! Keep it in original condition and packaging to avail easy return policy.
Certified product
Certified product
First impression is the last impression! Address the book’s certification page, ISBN, publisher’s name, copyright page and print quality.
Secure Checkout
Secure checkout
Security at its finest! Login, browse, purchase and pay, every step is safe and secured.
Money back guarantee
Money-back guarantee:
It’s all about customers! For any kind of bad experience with the product, get your actual amount back after returning the product.
On time delivery
On-time delivery
At your doorstep on time! Get this book delivered without any delay.
Notify me when this book is in stock
Add to Wishlist

About the Book

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.

Table of Contents:
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.


Best Sellers


Product Details
  • ISBN-13: 9780321103284
  • Publisher: Pearson Education (US)
  • Publisher Imprint: Pearson
  • Depth: 25
  • Height: 230 mm
  • No of Pages: 496
  • Series Title: Allyn and Bacon Series in Technical Communication
  • Sub Title: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)
  • Width: 180 mm
  • ISBN-10: 0321103289
  • Publisher Date: 06 Feb 2003
  • Binding: Paperback
  • Edition: 2
  • Language: English
  • Returnable: N
  • Spine Width: 25 mm
  • Weight: 797 gr


Similar Products

How would you rate your experience shopping for books on Bookswagon?

Add Photo
Add Photo

Customer Reviews

REVIEWS           
Click Here To Be The First to Review this Product
Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)
Pearson Education (US) -
Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)
Writing guidlines
We want to publish your review, so please:
  • keep your review on the product. Review's that defame author's character will be rejected.
  • Keep your review focused on the product.
  • Avoid writing about customer service. contact us instead if you have issue requiring immediate attention.
  • Refrain from mentioning competitors or the specific price you paid for the product.
  • Do not include any personally identifiable information, such as full names.

Writing Software Documentation: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)

Required fields are marked with *

Review Title*
Review
    Add Photo Add up to 6 photos
    Would you recommend this product to a friend?
    Tag this Book
    Read more
    Does your review contain spoilers?
    What type of reader best describes you?
    I agree to the terms & conditions
    You may receive emails regarding this submission. Any emails will include the ability to opt-out of future communications.

    CUSTOMER RATINGS AND REVIEWS AND QUESTIONS AND ANSWERS TERMS OF USE

    These Terms of Use govern your conduct associated with the Customer Ratings and Reviews and/or Questions and Answers service offered by Bookswagon (the "CRR Service").


    By submitting any content to Bookswagon, you guarantee that:
    • You are the sole author and owner of the intellectual property rights in the content;
    • All "moral rights" that you may have in such content have been voluntarily waived by you;
    • All content that you post is accurate;
    • You are at least 13 years old;
    • Use of the content you supply does not violate these Terms of Use and will not cause injury to any person or entity.
    You further agree that you may not submit any content:
    • That is known by you to be false, inaccurate or misleading;
    • That infringes any third party's copyright, patent, trademark, trade secret or other proprietary rights or rights of publicity or privacy;
    • That violates any law, statute, ordinance or regulation (including, but not limited to, those governing, consumer protection, unfair competition, anti-discrimination or false advertising);
    • That is, or may reasonably be considered to be, defamatory, libelous, hateful, racially or religiously biased or offensive, unlawfully threatening or unlawfully harassing to any individual, partnership or corporation;
    • For which you were compensated or granted any consideration by any unapproved third party;
    • That includes any information that references other websites, addresses, email addresses, contact information or phone numbers;
    • That contains any computer viruses, worms or other potentially damaging computer programs or files.
    You agree to indemnify and hold Bookswagon (and its officers, directors, agents, subsidiaries, joint ventures, employees and third-party service providers, including but not limited to Bazaarvoice, Inc.), harmless from all claims, demands, and damages (actual and consequential) of every kind and nature, known and unknown including reasonable attorneys' fees, arising out of a breach of your representations and warranties set forth above, or your violation of any law or the rights of a third party.


    For any content that you submit, you grant Bookswagon a perpetual, irrevocable, royalty-free, transferable right and license to use, copy, modify, delete in its entirety, adapt, publish, translate, create derivative works from and/or sell, transfer, and/or distribute such content and/or incorporate such content into any form, medium or technology throughout the world without compensation to you. Additionally,  Bookswagon may transfer or share any personal information that you submit with its third-party service providers, including but not limited to Bazaarvoice, Inc. in accordance with  Privacy Policy


    All content that you submit may be used at Bookswagon's sole discretion. Bookswagon reserves the right to change, condense, withhold publication, remove or delete any content on Bookswagon's website that Bookswagon deems, in its sole discretion, to violate the content guidelines or any other provision of these Terms of Use.  Bookswagon does not guarantee that you will have any recourse through Bookswagon to edit or delete any content you have submitted. Ratings and written comments are generally posted within two to four business days. However, Bookswagon reserves the right to remove or to refuse to post any submission to the extent authorized by law. You acknowledge that you, not Bookswagon, are responsible for the contents of your submission. None of the content that you submit shall be subject to any obligation of confidence on the part of Bookswagon, its agents, subsidiaries, affiliates, partners or third party service providers (including but not limited to Bazaarvoice, Inc.)and their respective directors, officers and employees.

    Accept

    New Arrivals


    Inspired by your browsing history


    Your review has been submitted!

    You've already reviewed this product!
    ASK VIDYA