Home > Computing and Information Technology > Computer programming / software engineering > Software Engineering > 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)

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

          
5
4
3
2
1

Available


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.
Quantity:
Add to Wishlist

About the Book

Part of the new 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 contains "How to Read this Chapter," “Examples,” “Guidelines,” “Discussion,” “Glossary,” “Task Analysis Checklist,” and “Practice/Problem Solving” sections. 1.Understanding Task Orientation. Emphasize Problem-Solving. Provide Task-Oriented Organization. Orient Pages Semantically. Facilitate Information Tasks. Use Multi-Document Support. Design for Users. Facilitate Communication Tasks. Encourage User Communities. Support Cognitive Processing. The Goal of Software Documentation. A Definition of Task Orientation. The Theory behind Task Orientation. 2.Analyzing Your Users. Choose Users Carefully. Anticipate Transfer of Learning: Studying Non-Computer Mediated Tasks. Mock-Up Hard-to-Contact Users. Write User Scenarios. Plan Interviews Carefully. Involve Users in All Phases of the Project. Identify Document Goals. Tie the User Analysis to Documentation Features. The Importance of a Thorough User Analysis? What Does Use Mean? Things 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 Pattern: Regular, Casual, Intermittent. 3.Constructing a Task List. Determine the Right Level of Detail. Categorize the Program Tasks. Link the Program Tasks with Menu Features. Write Steps as Actions. Break Up Long Tasks into Subtasks. Don't List Options as Steps. Test Your Task List. The Task List as Part of the Overall Process. How to Get Task Information from Programmers. Program Tasks and Document Forms. Relating the Program Task List to the Overall Project. 4.Planning and Writing Your Documents. Create a Task List. Work Backwards from the Delivery Date. Assign People to Tasks. Work in the Drop-Dead Mode. Make the Documentation Plan Persuasive. The Documentation Process. Considerations for Planning Online Help Systems. Organizing Your Writing Team. The Documentation Plan. Reviewing the Documentation Plan. An Outline for a Documentation Plan. 5.Getting Useful Reviews. Review Throughout the Documentation Process. Write the Review Plan. Review the Document Objectives from the Documentation Plan. Determine the Type of Review Needed. Write a Cover Letter with Questions for the Reviewers. Establish a Review Schedule. Prepare Feedback Materials for Reviewers. See Reviewers as Partners. Handle Conflict Diplomatically. Reviewing Defined. The Purpose of Reviews. Do a User Walkthrough. 6.Conducting Usability Tests. Follow a 10-Step Test Plan. Tie Testing in with Document Objectives. Do Some Pilot Testing. Make the Test Objective. 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. 7.Editing and Fine Tuning. Know Your User. Take a Constructive Attitude. Don't Edit Your Own on Your Own. Use Editing Forms. Edit Strategically. Develop an Editor's Reading Skills. Consult Standard Style Guides. Don't Confuse Editing Tasks with Other Tasks. Writing versus Editing. Editing in Desktop Publishing Environments. Problems with Editing Manuals and Online Systems. How Do You Know What's Correct? Editing and Task Orientation. 8.Designing for Task Orientation. Follow a Problem-Solving Process. Meet user Task Needs. Try Out Ideas on Users. Examine Existing Documentation. Review the User Analysis. Acknowledge Production Constraints. Design the Documentation as a System. The Design Problem. Solutions to the Design Problem for Printed Documentation. Solutions to the Design Problem for Online Documentation. 9.Laying Out Pages and Screens. Create Page Grids. Draw Thumbnail Sketches. Define Styles for Pages and Screens. Set Up Pages and Styles in Your Word Processor. Online Help Can Repeat Printed Information. The Goals of Page and Screen Layout. Designing Communication Spaces. How to Look at Pages and Screens. A Gallery of Page and Screen Designs. Common Page Designs. The Elements of Page Design. Common Screen Designs. The Elements of Screen Design. Designing Type. Helping People Recognize Words. Design Advice. The Idea of Body Text. Non-Body Text. 10.Getting the Language. Focus on Actions Rather Than Functions. Use the Active Voice. Keep Writing Simple. Build Parallel Structures. Use Operational Overviews. How Do We Process Language? Performance-Oriented Language. How Do We Remember and Learn? Style Problems in Software Documentation. 11.Using Graphics Effectively. Answer Users' Questions. Make it Visible. Keep Graphic Styles Consistent. Don't Over-do Graphics. Label Consistently. Use Typographic Techniques. Size the Image Correctly. Functions of Graphics. Types of Graphics in Software Manuals and Online Help. Elements of Graphics. 12.Writing to Teach -- Tutorials. Identify Skills You Need to Teach. State Objectives as Real-World Performance. Choose the Right Type of Tutorial. Present Skills in a Logical, Cumulative Structure. Offer Highly Specific Instructions. Give Practice and Feedback at Each Skill Level. Test Your Tutorial. Designing Tutorials. The Elaborative Approach. The Minimalist Approach. 13.Writing to Guide -- Procedures. Determine How Much Information Your User Needs. Choose the Appropriate Instructional Format. Follow a Rhythm of Exposition. Test All Procedures for Accuracy. What Constitutes a Procedure? How Does a Procedure Work? 14.Writing to Support -- Reference. Choose the Right Form of Reference. Decide What to Include. Establish a Pattern. Organize the Reference Section. Show How to Use the Reference Information. The Psychology of the Reference User. The Psychology of a Reference Entry. 15.Designing Indexes. Decide on the Indexing Methodology. Decide What to Index. Identify the Level of Detail. Decide on Phrasing and Format. Build and Proofread. Why an Index? Online Index Versus Print Index Versus Keywords. Endnotes. Index.


Best Sellers


Product Details
  • ISBN-13: 9780205195763
  • Publisher: Pearson Education (US)
  • Publisher Imprint: Pearson
  • Height: 235 mm
  • No of Pages: 484
  • Spine Width: 25 mm
  • Weight: 848 gr
  • ISBN-10: 0205195768
  • Publisher Date: 28 Nov 1997
  • Binding: Paperback
  • Language: English
  • Returnable: Y
  • Sub Title: A Task-Oriented Approach (Part of the Allyn & Bacon Series in Technical Communication)
  • Width: 178 mm


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