Managing Your Documentation Projects [Paperback]

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.

Perhaps the biggest stumbling block to widespread acceptance/adoption of the PMM is the underlying need of "enlightened" organizations that appreciate (with time, money and resources) and understand the value-add such a process can provide, and those organizations are few and far between. You can have JoAnn's company perform a PMM audit for PMM certification (not sure how much that counts for in the business world--yet), or you can try to be compliant by following the suggestions outlined in the book. But if you're not a software shop, you'll have to make your own adjustments to the PMM requirements and scale appropriately.

All in all, I think the book provides some great direction for a documentation project management process that has to be scaled to meet your business/industry needs. This book has and will continue to serve as a springboard for more discussions and new initiatives in the technical communications field.