We Are Moving Our Blog and Changing Name

We have moved our blog to Google Blogger and changed the name to: http://mcculley-cuppan.blogspot.com/

Putting the blog on a Google server makes it easier for us to focus on the blog content and get away from the hassles of managing the server.

So click on the link and come on over to the new location and check out the recent posts we have added:

How important is language and writing style in a clinical study report?

Not knowing when good is good enough in writing research reports

Change change is everywhere…yet it all remains the same

Posted in Communication of Science, Dissemination of Knowledge, Improving Review Practices, Propagation of Knowledge, Teaching Writing to Life Science Professionals, Writing in the Life Sciences | Leave a comment

More thoughts on the limited sophistication of documentation practices in the life sciences

I mentioned in this post that I consider the documentation practices for creation of regulatory submission documents in most pharma and medical device enterprises to rather unsophisticated. My position is largely driven by comparing observations of documentation practices to descriptions of varying levels of documentation maturity we have developed. Our descriptors have their roots in the work presented by Joann Hackos in her book: Managing Your Documentation Projects.

Like Hackos, our documentation practices-maturity model is a six point scale ranging from: Level 0Oblivious to Level 5Optimizing. My observations suggest that the vast majority of regulatory writing falls into the 2.5 range, which is between Rudimentary and Organized/Repeatable.

The Rudimentary documentation organization is one where the vast majority of effort is placed to ensure documentation consistency. All documents are generated utilizing well characterized templates. Document strategic review is largely absent as energy is applied to ensuring structural (that is, grammar and format) accuracy and consistency. Work practices are highly individualized and there is little application of meaningful estimating of document size or time lines.

The belief statements of organizations working at the rudimentary level include the following:

  • All writers manage their own projects
  • We would like to know more about our reading audience, but nobody takes the time to learn more….so we “suppose” what they want in our documents
  • Our users are just like us…….I am a subject matter expert, so every other person educated like me will read documents just like I do
  • We talk about what the data means, but we rarely talk about how to represent this meaning in our documents until we are into round table reviews
  • We have little concern with how many rounds of review go into creating the final version of a document….we strongly endorse the credo “the end justifies the means”
  • Planning document content before actually writing a report is just busy work
  • We routinely reverse engineer document development timelines from the stated publication deadline and not from the scale and scope of the intended document
  • We care what the customer thinks of our documents, but we do not use any organizationally applied quality standards. Standards are principally driven by teams and their senior reviewers
  • File and forget–we do not take time to collectively reflect on documentation work practices practices

The belief statements of organizations working at the organized and repeatable level include the following:

  • We have begun to study our document users but see little value in a concerted effort to collect information on how well our documents “satisfice” their needs
  • We are surprised or even indignant when we get questions from our regulatory user looking for information that we included in our submission package
  • The quality of our document project management is inconsistent, but we are okay with that because that is reality and each project is unique
  • We do not see meaningful metrics beyond time for documentation projections…if we meet the deadline, then ways of working had to be good
  • Nobody knows what others are doing in the process of review…the only way they know is via what may be discussed during a round table review
  • We believe in our described “ways of working” until faced with unexpected situations, then we panic and call for “all hands on deck”
  • We can easily get caught up in “process” at the expense of “product”

Now let’s contrast the above with belief statements of organizations working at the optimized level which include the following:

  • We always engage in collaborative pre-writing planning of documents to make sure we fulfill strategic purpose of any given document
  • We are thoroughly committed to understanding our document users and we work to systematically collect information from them
  • We know how big a document will be even before we write it
  • We always do end-of-project analysis to collect lessons learned and then disseminate this information across the organization
  • We maintain a database of critical documentation work practice parameters and benchmark all documentation projects
  • We recognize that accuracy and consistency are just the start of ensuring quality….we have expanded focus to quality of argument and document usability
  • We are learning how to be innovative and not let the process control us
Posted in Writing in the Life Sciences | Tagged , , , , | 1 Comment

Designing the architecture of the argument in development reports

Kirk Livingston, a teacher and a medical writer working largely in the medical device industry, as well as a fellow blogger at LivingstonContent, shared this comment on my previous post regarding poor rhetorical shaping of arguments in research reports.

There’s a lot of work involved with producing solid, well-reasoned conclusions. Can it even be accomplished as an “authoring team” or is it the work of an individual? Recent research about medical device companies in Minnesota suggests communication teams are chronically understaffed. So–who has time to come to the right conclusions? Thanks for the thoughtful post.

I agree there is considerable work that goes into producing solid, well-reasoned conclusions. I am certain the work can indeed be accomplished by an authoring team. The caveat here is, it can be accomplished as long as the team engages in truly collaborative authorship work practices and makes use of pre-writing planning tools to help shape the argument.

I am not so sure that writing teams are chronically understaffed. I think the real issue here is the limits of interest and skill that team members may have towards the task of writing. As I reflect on 17 years of work associated with the authorship of regulatory documentation, I am convinced adding numbers to the equation will have little bearing on the rhetorical qualities of any given document. Larger writing teams will likely yield only emotional comfort–the notion of safety in numbers.

Producing high quality documents is a function of knowing what you want the document to do for you, a sense of where arguments must be played out in a document, and what writing tools to use in order to get true collaboration and sharpen everyone’s focus to achieve the objectives you want to document to support.

Producing high quality documents in the forum of pharmaceutical and medical device research requires understanding how to build out the red thread of logic in a research report. In pre-writing planning it starts with something as simple as building a table that is to be filled in by the authoring team. The table has three columns to be completed by the team:

Primary & Secondary Objectives | Conclusions | Key Data

You then have one row in the table for each objective.

The team’s task is then is to build out conclusions about achievement of each objective and what data warrants that conclusion.  A simple but powerful writing tool that helps a team to lend considerable shape to the architecture of the argument that must be represented within a report.

Posted in Communication of Science, Writing in the Life Sciences | Tagged , , , , , | Leave a comment