Managing Your Documentation Projects

I've been writing tech docs for 20 years. I've implemented bits and pieces of Hackos' techniques everywhere I've worked since the book came out in '94. They always work, as long as (a) you aren't the kind of idiot who prefers to swat every gnat with a jackhammer, and (b) you aren't working with three or more of the following: (1) cowboy coders, (2) clueless engineering managers, (3) marketing people who've stopped taking their meds, and (4) the usual species of techpubs dino who prefers extinction to following *any* process s/he didn't actually invent. Even if you disagree violently with some of her approaches (as I do), you'd have to be mighty ignorant to disagree with all of it. If you're a techpubs newbie, buy it right now. Very soon, you will be managing a doc project on your own, and if you don't have a rabbi somewhere, Ms. Hackos will be your only hope.

This book is about the process of managing documentation projects. Since my company adopted the methodology described in this book, all of our projects have come in ahead of time and under budget...no matter what the size of the project.The methodology helps communicators and clients focus on what is important in the development of information products. By focusing on what information users need to do their jobs, content becomes obvious.Understanding the process of information development is critical to being able to measure the quality and effectiveness of the work. Only by adopting a policy of continuous process improvement can we increase our value to our organizations and to our customers. Dr. Hackos provides the method for doing this. While it was written in 1994, I still find it applicable in 2001!

For novice or experienced writers, this book offers more insight into good documentation processes than any other book I have read. The approach advocated by the author is applicable in any documenation development effort, be it hardware or software, commercial or mil spec. There really is something for everyone.This book focuses on the need for a solid planning effort as the basis for all major decisions. Information planning, content planning, scheduling, and resource allocation are all covered in a comprehensive and thorough manner. Throughout the book, the author chooses as an organizing principle the concept of a documentation life cycle. Thus, readers have a conceptual framework that they can use to relate what the author has written to their own experience.As well, the author classifies the stages of development of a publications group from chaos to a team capable of a managed, repeatable, and worthwhile effort that enhances the product. I have had both the misfortune and good fortune to have worked with each type of organization that the author describes. The descriptions are breathtaking in their accuracy.This book is written in a very readable style. There are numerous case studies and examples. Clearly, the author has extensive experience and has drawn upon this to provide a very useful book.This book should be on every technical writer's shelf.

I have used this textbook twice instructing advanced technical writing courses at Portland State University. I have found it easy to use, well-written, and organized the way I expect it.The main point Hackos makes is that every publications department sits somewhere on the planning continuum. She introduces the concept of the Publications Development Life Cycle (PDLC). Your department may range from Level 0, oblivious, to Level 5, continuously incrementally improving. She identifies the main tasks needed to move from one level to another.The three main tools used to plan for projects are the information plan, a high-level strategic document; the project plan, a set of timelines and estimates for page counts and money; and a content specification, a detailed outline of every deliverable. Hackos has done a masterful job of setting forth the theory behind the reasoning. Her examples demonstrate not only how important planning is, but the commitment that has to be made to make it succeed. If every technical writer had this book on their shelf, our profession would take a huge step forward.

This book is absolutely excellent. The information is laid out well and the suggestions have helped me beyond words. I now create Information Plans and other documents prior to starting a new project and the results have been wonderful.The results of this "pre" documentation have proven very effective further down the road and have assisted me in gaining larger budgets for my team, as well as additional projects.