Tuesday, June 30, 2009
Technical Writing 101, 3rd edition - a review
Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content, 3rd edition; Alan S. Pringle and Sarah S. O'Keefe, Scriptorium Publishing Services Inc., Research Park Triangle, NC, 2009, ISBN: 978-0-9704733-7-0, 328 p., $20.00 (PDF Download), $35.95 (paper)
Almost ten years ago, in my previous job, I was asked to train a co-worker to become a technical writer. She'd been working in our Marketing department, but her position had become redundant because of a corporate takeover. One of the books that really helped me was the first edition of Technical Writing 101. She was already a good writer, but the book introduced her to the specific requirements of our profession.
Since then a lot has changed. Think of just the last decade: Web 2.0, social media, DITA, Google, YouTube and rich media, to name just a few. And the corporate environment has changed, putting greater demands than ever on writers to be efficient and productive. This edition of the book has been thoroughly updated to cover these new technologies and the demands they make on writers.
As you'd expect, the core of the book covers the basics: writing, procedures, using graphics, editing and being edited, and indexing. But, as most new writers quickly find out, writing is only a small part of the job. The book starts by explaining the many things that writers do other than writing. The second chapter explains the importance of templates and structure, and the third discusses documentation plans and outlines, both critical tools in a writer's arsenal. (A sample documentation plan is provided as an Appendix). Only one relatively short chapter is devoted to tools, probably appropriate considered many writers' tendency to obsess over tools rather than content.
Later chapters discuss more advanced topics, ones that really exist for most writers when the first edition of this book came out - structured authoring (XML and DITA), and Web 2.0 (wikis, blogs, and other social media). The final chapter is about how to get your first job as a technical writer.
Although Technical Writing 101 is aimed at new writers, topics are covered in enough detail that more experienced writers can use the book as a refresher or a reference to unfamiliar topics. For example, the indexing chapter is 15 pages long and covers most of the things any writer would need to know about the subject. The chapter on structured authoring would be a good introduction to anyone thinking about switching from unstructured authoring to DITA. Many sections include short sidebars providing tips and best practices; for example, the Getting Information chapter has a list of 30 suggestions for getting information from developers - a task that many writers, beginning and experienced, find difficult.
Technical Writing 101 would be an excellent choice as a text in college-level technical communication programs. It's hard to imagine anyone coming up with a better introduction to the field for new writers. But even experienced writers can benefit from reading this book. It contains a wealth of tips and practical information. If you have a manger who's not a writer, give them a copy. It might help them appreciate your job a little more.
Contest note: Today (June 30) is the last day to enter a draw for a copy of this book.
Almost ten years ago, in my previous job, I was asked to train a co-worker to become a technical writer. She'd been working in our Marketing department, but her position had become redundant because of a corporate takeover. One of the books that really helped me was the first edition of Technical Writing 101. She was already a good writer, but the book introduced her to the specific requirements of our profession.
Since then a lot has changed. Think of just the last decade: Web 2.0, social media, DITA, Google, YouTube and rich media, to name just a few. And the corporate environment has changed, putting greater demands than ever on writers to be efficient and productive. This edition of the book has been thoroughly updated to cover these new technologies and the demands they make on writers.
As you'd expect, the core of the book covers the basics: writing, procedures, using graphics, editing and being edited, and indexing. But, as most new writers quickly find out, writing is only a small part of the job. The book starts by explaining the many things that writers do other than writing. The second chapter explains the importance of templates and structure, and the third discusses documentation plans and outlines, both critical tools in a writer's arsenal. (A sample documentation plan is provided as an Appendix). Only one relatively short chapter is devoted to tools, probably appropriate considered many writers' tendency to obsess over tools rather than content.
Later chapters discuss more advanced topics, ones that really exist for most writers when the first edition of this book came out - structured authoring (XML and DITA), and Web 2.0 (wikis, blogs, and other social media). The final chapter is about how to get your first job as a technical writer.
Although Technical Writing 101 is aimed at new writers, topics are covered in enough detail that more experienced writers can use the book as a refresher or a reference to unfamiliar topics. For example, the indexing chapter is 15 pages long and covers most of the things any writer would need to know about the subject. The chapter on structured authoring would be a good introduction to anyone thinking about switching from unstructured authoring to DITA. Many sections include short sidebars providing tips and best practices; for example, the Getting Information chapter has a list of 30 suggestions for getting information from developers - a task that many writers, beginning and experienced, find difficult.
Technical Writing 101 would be an excellent choice as a text in college-level technical communication programs. It's hard to imagine anyone coming up with a better introduction to the field for new writers. But even experienced writers can benefit from reading this book. It contains a wealth of tips and practical information. If you have a manger who's not a writer, give them a copy. It might help them appreciate your job a little more.
Contest note: Today (June 30) is the last day to enter a draw for a copy of this book.
Labels: books, technical communication
Comments:
Keith, I enjoyed reading your review. TW 101 is my favorite introductory book for technical writers. I appreciate its real-world view and honest style of writing.
I have frequently recommended the book to new writers or to anyone who's considering entering the profession. A few years ago, I even re-read much of it. It certainly is a great refresher.
Post a Comment
I have frequently recommended the book to new writers or to anyone who's considering entering the profession. A few years ago, I even re-read much of it. It certainly is a great refresher.
