Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation

by Alan S. Pringle, Sarah S. O'Keefe, Sarah O'Keefe

Book Overview

Details the skills you need as a technical writer to create both printed and online content. This valuable reference describes the entire development process-planning, writing, visual design, editing,... This description may be from another edition of this product.

• Format: Hardcover
• Language: English
• ISBN: 097047332X
• ISBN13: 9780970473325
• Release Date: July 2003
• Publisher: Scriptorium Press
• Length: 284 Pages
• Weight: 1.12 lbs.

Customer Reviews

101 for exposure to Professional Writing and baseline concepts

If you have not read it, I suggest "Technical Writing 101". This is a 101 book and is not a complete writer's guide (Strunk n White, Gregg, etc handle style and similar books cover advanced templates and structure). It is a great tool for professional writing exposure and basic understanding of the process. Such as how Tech Writing differs from normal writing, how to work with subject matter experts (SME) in a political manner, and even a bit on resumes and getting into the field or freelancing. It wraps up with a reference section of online resources and societies to continue your learning. I keep spare copies to give as gifts both for those interested in the career of Tech Writing and to ease interaction with difficult SMEs. I also have had a few friends that borrowed it for guidance with term papers. Again it is an introduction to professional writing and process to which most college students have not yet had exposure. This is also a great tool to initially train new hires when you would rather have a common reference point.

Straightforward and clear

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.

Who are these people called Technical Writers?

I had never even heard the term "Technical Writer" until I was hired as one in 1998. Previously I had been working as a software trainer and had become very dissatisfied with off the shelf training materials. Consequently I ended up writing all of my own material, as well as take-home job aids and reference books. These books were very well received and hence a love of writing began. After leaving the Government and moving to the USA, I no longer wanted to train but I wanted to continue writing since I had enjoyed it so much. I was later hired as a technical writer for a fortune 500 company in Oklahoma. A friend of mine back in Canada wanted to know what I was doing but I didn't know how to explain it in 20,000 words or less. Sarah rescued me by writing this book and I immediately ordered it. Not only is the material accurate; the book is funny, immensely readable and short enough to be absorbed by a non-techie within a few hours. I sent the book to my friend and she finally understands what I do (or rather USED to do!) Never, when I wrote "The WordPerfect 5.1 Reference Series" for the Canadian Government did I think I would be launching a satisfying lifetime career. Thank you Sarah and Alex for putting into words the details of what technical communication is all about, and how to go about much of it!

The book's title & focus is clear, concise and unambiguous.

A concise guide for beginning (and experienced) technical writers. After reading this book, I would love to recommend it to anyone who hires, teaches or works with technical writers and associated professions. The book provides an excellent introduction into the world of technical writing and why its more than just writing. Editing, graphics, indexing, usability, project management and organizational skills, presentation and interviewing skills are just some of the skills needed as a technical writer and are these are well covered in this book. Especially noteworthy is the chapter on localization (L10N) and internationalization (I18N). The only drawbacks to the book is its reliance on using examples from software documentation and use of Adobe FrameMaker. I would have to disagree with the authors statement that technical writing for software accounts for 85% of all technical writing. Although it is surely more than 50%, no references are made to technical writing in fields such as manufacturing, machinery operation and maintenance, tools, appliances.That being said, if you're a technical writer or want to become one, this book is for you. If you're not a technical writer, but work with one or may hire one, then I highly suggest this book to find out what technical writing is about and how a good technical writer can add value to your company or organization. As stated in its subtitle, it is truly a "real world guide to planning and writing technical documentation".

For newbies and gurus alike!

Alan Pringle and Sarah O'Keefe have provided an excellent introduction to the field of technical writing. For those just starting out in the field, you'll understand precisely what you will face. For those who have been around awhile, you'll find nuggets of inspiration and true-to-life humor that will help you face another day. As a tried and true technical writer, I found the chapters on "Getting Information," "Editors -- Resistance is Futile," and "Indexing" to be excellent explanations of key parts of the technical writing process. Technical Writing 101 is well-written, summarizes the technical writing process with appropriate technical detail, and is enjoyable to read! You can't go wrong with a text like this!