Product Details
Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation, Second Edition

Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation, Second Edition
By Alan S. Pringle, Sarah S. O'Keefe

Price: $35.95 & eligible for FREE Super Saver Shipping on orders over $25. Details

Availability: Usually ships in 24 hours
Ships from and sold by Amazon.com

13 new or used available from $23.89

Average customer review:

Product Description

To succeed in technical writing, you need a lot more than just writing ability. Technical Writing 101 details the skills you need as a technical writer, and it explains how to handle the pressures of tight deadlines and ever-changing product specifications. This valuable reference also describes the entire documentation process—planning, writing, editing, indexing, and production.

This updated second edition features the latest information on single sourcing and a new chapter on how trends in structured authoring and Extensible Markup Language (XML) affect technical writers.


Product Details

  • Amazon Sales Rank: #176554 in Books
  • Published on: 2003-07
  • Original language: English
  • Number of items: 1
  • Binding: Paperback
  • 288 pages

Editorial Reviews

Review
The [first edition's] pace is brisk, the writing crisp and clear....business principles behind technical writing shine through as well. -- Technical Communication: Journal of the Society for Technical Communication, May 2002

From the Author
Have you ever thought:

"Hey, I'm a good writer. I wonder if tech writing would make sense for me?"

If so, this is the book for you. Technical Writing 101 is a concise handbook that describes what it really takes to make it as a technical writer.

Technical Writing 101 explains that in addition to writing ability, technical writers also need a grasp of technical subjects, planning and organizational skills, and the ability to extract information from sources, which often means coaxing information from harried product developers. Tact, diplomacy, persistence, and a good sense of humor are essential.

The second edition features updated information about single sourcing, which is the process of creating different types of content (for example, printed documents and web pages) from one set of files. Limited budgets force many documentation departments to rely on single sourcing, so an understanding of single-sourcing techniques is essential for prospective technical writers.

This edition also contains a new chapter about how structured authoring affects technical writing. Structured authoring is a publishing workflow that enforces consistent organization of content. For example, if you write a list, the list must have two or more items. If a list doesn't have at least two items, your text processing software displays an error. Structured authoring may seem intimidating at first, but Technical Writing 101 clearly describes the process and its many benefits.

If you're working toward a degree in technical writing, this book is a great complement to your more theoretical classes.

About the Author
Alan S. Pringle is lead technical editor at Scriptorium Publishing Services, Inc., and director of its publishing imprint, Scriptorium Press. The company provides technical publishing services to high-tech companies, including outsourced documentation solutions, technical training, and consulting. Since 1990, he has worked as a technical writer and editor on projects ranging from writing user guides for laser printers to editing course material for telecommunications equipment. Alan has also established corporate style guidelines and implemented XML-based structured applications for FrameMaker workflows. He is coauthor of the FrameMaker 7 Workbook Series.

Sarah S. O’Keefe is founder and president of Scriptorium Publishing Services, Inc. Sarah is an experienced FrameMaker trainer; she has both Certified Technical Trainer (CTT) and FrameMaker Adobe Certified Expert (ACE) credentials. Her background also includes technical writing, technical editing, production editing, and extensive online help development with various help authoring tools. Sarah is coauthor of FrameMaker 7: The Complete Reference. Currently, she works as a consultant to assist companies in implementing publishing solutions, including XML-based structured authoring.


Customer Reviews

Practical and Educational5
As the title mentions, Technical Writing 101, provides real-world planning tips. I found it to be very engaging, informative and very easy to read (finished within 24 hours of receiving it). It also sparked ideas on how I could look at a lot of projects I'm personally working on. The way the book is organized doesn't overload you with "too" much information. It also is very generous in providing other resources for further research and knowledge.

I would definitely recommend it to anyone who wants to get a good understanding of the technical writing process.

A one-time read for beginners3
This book provides a good overview for those considering a technical writing career. It may also be helpful for engineers and others who work with technical writers or who want basic ideas for preparing documentation. The chatty, breezy writing style makes the book an easy read. But the lack of in-depth information and its focus only on documentation and online help projects limits the book's usefulness as a daily work reference.

Straightforward and clear5
I thought this book was exactly what it said it was: a 101-level focus on technical writing. From the skills required by a good writer, to a technical writing process, to the task-oriented focus of user guides, this book covered all the basics, and was even written with a sense of humor. I am purchasing this for my technical publications department, because I think it's good to review the basics as a team, and there are specific topics that are newer to the team, such as how to write for globalization.