21 March 2011

More on Sophistication of Writing Groups

In our McCulley/Cuppan version of a Documentation Capability Maturity Model, the fourth level is called Organized and Repeatable as suggested by JoAnn Hackos in her various books. But perhaps a better term to use in place of repeatable is consistent, as at the fourth level, the application of well-defined work practices is much more consistent across documentation projects. In these organizations, the majority of team members operate by the credo: we recognize some of our processes and work practices represent "best of craft" and we know they will get us through any crisis.

At this level, the writing group does keep project tracking data in a simple database. Unfortunately,  most of the data only tracks time and draft iterations. These remain the only parameters used to create project milestones.

At this level there is some recognition that the role of the medical writer involves more than "just writing" and on some teams writers are seen as knowledge managers and they are actively involved in team meetings well before data base lock. However there remains credibility issues for the writing group in the broader organization where writers are often seen as necessary evil and only "just write" the reports.

A fourth level writing organization routinely uses pre-writing planning and project kick-off meetings to shape team expectations. At this level, the writers are more aware of document design considerations that impact usability, but little effort goes into mounting discussions with teams about document design during the pre-writing planning. This remains a discussion item for draft review.

Little attempt is made to formally collect information from document end-users about readability and usability of the documents submitted to them. Any information collected happens on a casual basis and is largely applied in ineffective ways.

Some of the belief statements found in the Level 4 Writing Group are as follows:

  • We are surprised and even sometimes mad at our document end-users when we get questions from them regarding information that was incorporated into submitted documents.
  • We recognize that we cannot just have meetings where we talk about the data, that we need to have meetings where we plan how and what we are going to say about the data in the reports, but this does not always happen.
  • We have good pre-writing planning and review tools, but it is a struggle to get the subject matter experts to actually use them.
  • Reviewers still spend too much time editing and not reviewing because they believe editing style and word choice help to make a document significantly better.
  • During the review process many reviewers still feel compelled to revisit sections already reviewed in an earlier draft version of the document.
  • Team members recognize best practice review calls for different roles and points of focus during the review process, but many still do not follow the guidance.
  • Sometimes we get stuck in our processes and still like to make all documents "look just like the last one that got approved."

No comments:

Post a Comment