Managing Your Documentation Projects (Paperback)

by JoAnn T. Hackos (Author) "Have you seen RC Magazine?..." (more)
Key Phrases: project management notebook, publications project manager, publications team members, Content Specification, Project Duration Figure, Changed Item Matrix (more...)

Editorial Reviews

Product Description
Practical, authoritative, and the first comprehensive guide to managing every phase of your publication project… The only book devoted exclusively to technical publication project management, Managing Your Documentation Projects arms you with proven strategies and techniques for producing high-quality, extremely usable documentation, while cutting cost and time-to-market. Dr. JoAnn T. Hackos, a top documentation design and project management consultant to major corporations, including IBM and Hewlett-Packard, shares with you the fruit of her more than 15 years of experience in the field. She gives you:

• Clear-cut, rational guidelines to managing every phase of the project from planning and development, through production, distribution, and project evaluation
• Scores of usable templates, checklists, summaries, and forms
• Dozens of real-life case studies and scenarios taken from the author’s extensive experience at top corporations
• Techniques applicable to virtually all fields of documentation

Managing Your Documentation Projects was designed to function as a comprehensive guide for new managers and a daily tool of survival for veterans. It is also an invaluable resource for technical writers, editors, graphic designers, consultants, and anyone called upon to produce high-quality technical documentation on time and within budget. JOANN T. HACKOS, PhD, is President of Comtech Services, Inc., an information/design firm in Denver, Colorado and San Jose, California. She is also president of JoAnn Hackos & Associates, Inc., a strategic planning and management consulting firm. In 1993, she served as president of the Society for Technical Communication (STC) and is a frequent conference keynote speaker on such topics as quality and usability of products and services, the importance of meeting the needs of the customer, and project management.

From the Publisher
Technical communication encompasses many subject areas, from computers to medicine to the latest VCR. Technical information is explained by writers, editors, graphic artists, graphic designers, programmers, indexers and managers. This book is a practical, compact text that demonstrates the steps used in starting, maintaining and completing documentation projects in a timely, high-quality fashion.

See all Editorial Reviews

Product Details

• Paperback: 656 pages
• Publisher: Wiley; 1 edition (March 23, 1994)
• Language: English
• ISBN-10: 0471590991
• ISBN-13: 978-0471590996
• Product Dimensions: 9.5 x 7.2 x 1.5 inches
• Shipping Weight: 2 pounds (View shipping rates and policies)
• Average Customer Review: 4.0 out of 5 stars See all reviews (26 customer reviews)
• Amazon.com Sales Rank: #482,602 in Books (See Bestsellers in Books)

Customer Reviews

Most Helpful Customer Reviews

47 of 48 people found the following review helpful:

3.0 out of 5 stars Not the Gospel, February 6, 2003

By	A reader from (California, United States) - See all my reviews

Joanne Hackos is widely acknowledged as a leading authority on technical publications management, largely because (a) she has some good things to say and (b) her _Managing Your Documentation Projects_ is one of the few books on the topic. This book offers some valuable insights about basic project management, but tries to shoehorn publications project management into a particular software development methodology -- Carnegie-Mellon's Capabilities & Maturity Model. Hackos acknowledges her debt to CMM and warns that trying to implement the model described in this book is tough sledding if the development organization is not using CMM.

After 20 years as a technical writer and publications manager, I've come to believe that all publications lifecycle systems are doomed unless they map directly to the development methodology engineering management supports and uses.

(I've also come to believe that most development methodologies are more often than not honored in the breach.)

If, as a publications manager, you're not aware of the development methodology your engineering managers have adopted, you need to get over and talk to them now. Even if they haven't adopted a formal, academic model, they do have some idea about how they produce technical products. Tailor your publications lifecycle to their lifecycle -- don't seek to impose an alien "order" on their process.

(If your engineering managers can't articulate a methodology or say things like "We just code until we're done", you have bigger worries than your publications lifecycle, such as the near-term viability of your company.)

Too often I've seen tech pubs managers adopt the "Hackos model" and fail because it doesn't fit the organization's development style. A organization that adopts the Rapid Application Development (RAD) or "Extreme Programming" model, for example, isn't going to be too thrilled about endless sign-offs on planning documents that take nearly as long to write as the manual itself.

Instead, tailor your approach toward the high degree of interactivity inherent in such methods -- quick review cycles of small portions of text, for example, instead of waiting for a full draft of the book to be ready.

Too many erstwhile pubs managers skim this book, then adopt the project documents provided as models in the book as "fill-in-the-blank" busywork for their writers.

Tech pubs managers might be better served by learning the basics of project management (especially the interplay between resources, time, and scope) and reviewing the development model of the engineering organization than adopting the CMM-inspired approach Hackos describes in this book.

There is no one-size-fits-all method for producing documentation. And Joanne Hackos would be the first to tell you that.

35 of 35 people found the following review helpful:

3.0 out of 5 stars A Key to Senior Technical Writing Positions, September 15, 2000

By	Sheldon S. Kohn (Alpharetta, GA United States) - See all my reviews

Any technical writer seeking to move into the upper levels of the profession will find that "Managing Your Documentation Projects" is one of the most useful books to read. I agree with other reviewers' comments about the dreadful illustrations and the problems one would have putting the entire bulky method into place in many technical environments. Many of the sample conversations Hackos includes as examples of what can happen when the process is applied are almost unintentionally ironic.

However, my experience is that the process and information that Hackos offers in this book will give you some of the tools you need to land a senior-level position. As Hackos herself writes, the ideas and material she offers are there for you to use, to try out, to modify so that they fit the requirements of your particular environment.

Some readers may be a bit put off by Hackos' focus on planning and delivering print publications. I have found that the ideas are flexible enough to transfer to different media. The important thing is to use project management for technical communications projects.

There is considerable ongoing debate within the technical writing profession as to the value of process and planning for the work. One argument is that process and planning takes us away from our real work and provides a convenient excuse when projects do not progress as required. Proponents of this idea often say something like, "Shut up and write." Another side holds that careful analysis and planning are integral parts of our work and we cannot succeed without a defined process. I find that a lot of high-tech companies are looking for process. They know that they need structure to produce quality products in a predictable, reliable way.

One caution worth noting, as Hackos herself advises, is that the model would have to be modified extensively to work in a Rapid Application Development (RAD) environment. Another caution is always to remember that the method is not the goal. At times, it is more important to produce documentation than it is to revise the project management materials to keep up with the latest twist or turn in a project.

I recommend "Managing Your Documentation Projects" for technical writers looking to move ahead in their careers. It is a bit pricey, but I think that many people would find it money well spent.

54 of 57 people found the following review helpful:

3.0 out of 5 stars Should have been shorter, June 29, 1999

By	Robert Lawrence (Brooklyn, NY USA) - See all my reviews

I have very mixed feelings about this book. Clearly Hackos has a tremendous amount of experience and has seen many successful projects from start to finish. Nonetheless, I'm troubled by the length of the book and the heavy reliance on project management methodologies from other disciplines. Hackos has correctly recognized that a documentation project has to be broken into stages, and the stages she suggests are (pretty) good. But the sheer number of deliverables produced in each phase is overwhelming. By bombarding developers with doc deliverables (information plans, content specifications, etc.) during the development cycle, you risk becoming the ninny on your software project--or more precisely, the schoolmarm. And that, I think, is what bothers me about this book in general: the schoolmarmish tone that resurfaces throughout. There is just too much detail.

Hackos is correct to suggest that writers must establish better rapport with developers. I think the way to do that, however, is to get closer to real development methodologies (rather than writing methodologies) that are gaining steam today. (Best example: Rational Software's Unified Process.) If the profession is ever to get the respect it deserves, technical writers will have to become more like programmers, and less like English teachers.