New PDF release: Developing Quality Technical Information: A Handbook for

By Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde

ISBN-10: 0131477498

ISBN-13: 9780131477490

The e-book offers a far wanted method of caliber technical communique and a operating plan for reaching caliber. The examples are first-class and are effortless to exploit and adapt. The editorial recommendation is easy and transparent sufficient for tech writers who didn't significant in English or journalism. it really is so much helpful of a textual content in college courses, however it is extra worthwhile to skilled writers, editors and executives fascinated with elevating the standard in their courses. the most distinction among this and different books is that during all of the first 9 chapters, one caliber attribute is gifted so that you can follow for your writing undertaking to make technical details effortless to exploit, effortless to appreciate and straightforward to discover. There are checklists on the finish of every bankruptcy for overview and a high quality record within the appendix protecting the entire features. The publication indicates unique textual content and revision textual content that you should truly browse the booklet and notice the diversities utilized. this can be one other very good characteristic that are meant to capture a purchaser's eye.

Show description

Read or Download Developing Quality Technical Information: A Handbook for Writers and Editors (2nd Edition) PDF

Best technical books

New PDF release: Strategic Decision Making Applying the Analytic Hierarchy

Issues of excessive stakes, related to human perceptions and decisions, and whose resolutions have long term repercussions, demand a rational method of their answer. The Analytic Hierarchy method offers an efficient, formal method that provides information to such strategic point choice making difficulties.

Read e-book online Seehäfen: Planung und Entwurf PDF

? ber die Planung und den Entwurf von Seeh? fen ist aus der Perspektive der damit befassten Ingenieure seit ? ber forty Jahren kein Buch in deutscher Sprache erschienen. In diesem Zeitraum hat das st? ndige Anwachsen der Umschlagmengen zu immer gr? ?eren Schiffen und deren Spezialisierung gef? hrt. Diese Entwicklung hat Einfluss auf die Standorte der H?

Download e-book for iPad: Cover letters made easy by Patty Marler, Jan Bailey

Made effortless sequence hide Letters Made effortless CONTENTS: best 20 Openers To Get Your disguise Letter learn; Why a canopy Letter? ; hide Letter forms; What Employers search for; hide Letter understand how; supplier Transitions; placing all of it jointly; the nice, the undesirable, and the grotesque; pattern conceal Letters.

Extra resources for Developing Quality Technical Information: A Handbook for Writers and Editors (2nd Edition)

Example text

In the original set of steps, both the new user and existing user need to read both step 2 and step 3 to figure out what to do. The original steps are focused on the product, not the flow of the task. Revision To purchase tickets online: 1. com. 2. If you are a new user, set up an account: a. Click Register. b. Specify your credit card number and a name and password for your account. c. Click Submit. When the account is set up, a message will tell you to proceed. 3. Click I Have an Account. 4. Specify your name and password.

Separate the explanations of major concepts from the task topic by creating a topic for each major concept. Provide links to those concept topics from your task topic. That way, users who already understand the concepts can do the task, and users who need to learn about the concepts can go to the concept topics. This guideline deals with overcompleteness and is similar to the completeness guideline “Include only necessary information” on page 84. The following topic explains the concepts of a project and a suite before presenting the task: Original Creating test cases Projects are collections of files that are related to a test case.

The guideline “Focus on real tasks, not product functions” on page 27 of this chapter provides more discussion and examples of real and artificial tasks. Headings are elements that help users find information. Good headings produce a good table of contents, from which users can predict what they will find in each topic: task, conceptual, or reference information. Therefore, this guideline is related to retrievability as well as task orientation. The following headings are misleading and unhelpful: Original Register usage Administering authorization The Dial-up function Session initialization Using the Define Font Window Understanding hardware requirements Some of the original headings hide the fact that the topic contains task information; others define the tasks in terms of the product; and the last heading misrepresents a reference topic as a task.

Download PDF sample

Developing Quality Technical Information: A Handbook for Writers and Editors (2nd Edition) by Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, Elizabeth Wilde

by Anthony

Rated 4.23 of 5 – based on 17 votes