Read Me First! A Style Guide for the Computer Industry / Edition 2

Read Me First! A Style Guide for the Computer Industry / Edition 2

by Sun Technical Publications, Technical Pu Sun Technical Publications
     
 

ISBN-10: 0131428993

ISBN-13: 9780131428997

Pub. Date: 07/16/2003

Publisher: Prentice Hall

“Clear content and consistent style are essential for the usability of any system. If you're  doing something complex, describing it simply becomes that much more important. Read Me First! A Style Guide for the Computer Industry tells you how to achieve these elusive goals, and does so following its own advice: it's clear, consistent, and…  See more details below

Overview

“Clear content and consistent style are essential for the usability of any system. If you're  doing something complex, describing it simply becomes that much more important. Read Me First! A Style Guide for the Computer Industry tells you how to achieve these elusive goals, and does so following its own advice: it's clear, consistent, and presents advanced topics in an actionable and approachable manner.”

Jakob Nielsen
Principal, Nielsen Norman Group
Author, Eyetracking Web Usability

“The third edition of Read Me First! A Style Guide for the Computer Industry has all the excellent content of the first editions and more. The new chapters provide insights to new forms of communication. They include sound advice on writing alternative text for illustrations, writing narrations for screencasts, and working with wikis to enhance and manage content contributed by the user community. The material on writing procedures is invaluable for those who are struggling with task-oriented information. If you need to understand the best practices for developing useful and usable text, start with this volume.

It brings together a wealth of knowledge that all technical communication professionals must have to succeed.”

Dr. JoAnn T. Hackos, President, Comtech Services, Inc.

The definitive reference for technical writers, editors, and documentation managers, Read Me First! A Style Guide for the Computer Industry, Third Edition, has been revised and updated to cover everything from creating screencasts and referencing web sites to writing for wikis.

This award-winning guide to creating clear, consistent andeasy-to-understand documentation covers everything from grammar and writing style to typographic and legal guidelines. The authors, who are senior editors and writers at Sun Microsystems, share their extensive experience and provide practical tips and recommendations, including guidance on hiring writers, working with illustrators, managing schedules and workflow, and more.

The third edition features new chapters on:

•    Writing for wikis and encouraging wiki collaboration
•    Creating screencasts, using screencast terminology, and guidelines for writing narration
•    Creating alternative text for nontext elements such as screen captures, multimedia content, illustrations, and diagrams

It also includes new tables for symbol name conventions, for common anthropomorphisms, and for common idioms and colloquialisms. An updated and expanded recommended reading list suggests additional resources.


Read More

Product Details

ISBN-13:
9780131428997
Publisher:
Prentice Hall
Publication date:
07/16/2003
Edition description:
2nd Edition
Pages:
384
Product dimensions:
6.90(w) x 9.20(h) x 0.90(d)

Table of Contents

Preface19
1Mechanics of Writing1
2Constructing Text31
3Writing Style63
4Online Writing Style81
5Constructing Links101
6Writing Tasks, Procedures, and Steps115
7Writing for an International Audience135
8Legal Guidelines151
9Types of Technical Documents169
10Working With an Editor187
11Working With Illustrations199
12Writing About Graphical User Interfaces221
13Glossary Guidelines231
14Indexing241
ADeveloping a Publications Department273
B: Checklists and Forms303
CCorrect Usage of Terms311
D: Recommended Reading319
Index335

Read More

Customer Reviews

Average Review:

Write a Review

and post it to your social network

     

Most Helpful Customer Reviews

See all customer reviews >