4 Books Every Technical/Scientific Writer Should Considering Reading

The following books are ones that "new" technical and scientific communicators should consider reading. The books look at technical writing from different perspectives and will prove useful to the experienced communicator as well.

Metaphor and Knowledge: The Challenges of Writing Science. Ken Baake

Summary: “Metaphor and Knowledge offers a sweeping history of rhetoric and metaphor in science, delving into questions about how language constitutes knowledge. Weaving together insights from a group of scientists at the Santa Fe Institute as they shape the new interdisciplinary field of complexity science, Ken Baake shows the difficulty of writing science when word meanings are unsettled, and he analyzes the power of metaphor in science.” (partial text available from Google Books)

What Writing Does and How It Does It: An Introduction to Analyzing Texts and Textual Practices. Charles Bazerman, Paul Prior, editors

Summary: “In What Writing Does and How It Does It, editors Charles Bazerman and Paul Prior offer a sophisticated introduction to methods for understanding, studying, and analyzing texts and writing practices. This volume addresses a variety of approaches to analyzing texts, and considers the processes of writing, exploring textual practices and their contexts, and examining what texts do and how texts mean rather than what they mean. Included are traditional modes of analysis (rhetorical, literary, linguistic), as well as newer modes, such as text and talk, genre and activity analysis, and intertextual analysis.” (full text)

Technical Writing: Process and Product. Sharon Gerson and Steven Gerson

Summary: “Technical Writing: Process and Product guides readers through the entire writing process—prewriting, writing, and rewriting—developing an easy-to-use, step-by-step technique for writing the types of documents they will encounter on the job. The authors' reader-friendly style engages readers in the writing process and encourages hands-on application. Discusses prewriting, writing, and rewriting in relation to ethics, audience identification, electronic communication, and the role of technical writing in the workplace. For anyone looking to utilize more effective written communication in their jobs.” (summary and e-learning resources available at publisher's website)

Professional and Technical Writing Strategies: Communicating in Technology and Science. Judith VanAlstyne and Merrill D. Tritt

Summary: “Comprehensive and easy-to-read, this award-winning reference for those in technical, engineering, and scientific fields emphasizes practical writing. Its presentation and applications offer simple guides that users can easily emulate. It combines instruction, sample papers, exercises and writing projects for manuals, correspondence, research and publication articles, and oral technical communications.” (summary)

Originally published on our Knowledge Management blog

Why documentation work practices in pharma and medical device industries need enhancement

I recently taught a workshop for a client where I gave the participants a good news/bad news scenario. The good news, I suggested, is the documentation work practices I observed in their company were like what I saw in other pharma companies. I then suggested the bad news is their work practices were like what I saw in other companies. My point to them is that the bar for sophisticated work practices is set pretty low in the pharmaceutical industry.  I used as my line of reasoning our McCulley/Cuppan modification of JoAnn Hackos’ Document Capability Maturity Model (DCMM) she presents in her book: “Managing Your Documentation Projects.”

To this group I suggested their documentation work practices would come out at about a 2 on our 6 point scale, which suggests also the point on the scale I will place most of the documentation groups in the pharma industry. Most were surprised at the low ranking and a few were even offended I think. By the end of our workshop, all were feeling different about what it takes to create high quality technical documentation in the life sciences.

I’ll characterize here a documentation project undertaken by this group I had in the workshop and suggest such work is emblematic as to why I give them (and the industry) a low DCMM score.
The group generated a briefing document to be submitted to a regulatory health agency in advance of a request (a standard practice across the industry.) The briefing document is intended to inform the health agency as to what topics the company wanted to receive feedback from the health agency regarding an ongoing drug development project.
The company had an hour meeting with the agency and ended up wanting to address 8 topics within the hour (an ambitious agenda.)

The documentation team went through a three draft process to create the briefing package where the number of questions and the actual questions changed w/ each draft. I mean they were truly using a “fire; aim; now we are ready” approach to create this briefing package. The approach of: "activity is everything, so we are way too busy to plan."

Each draft looked dramatically different than the previous version and required massive investment of time and energy from the team. In the end the briefing package was 83 pages—that is a little over 10 pages per question. The first question did not appear until page 25 (which means there were 24 pages of introductions and throat clearing before we get to the meat. Curiously to me, none of the questions appeared in the Table of Contents of the briefing package and the document did not have an Executive Summary (we want you to work as hard in reading this document as we did in crafting it.)

Then I asked the authoring team what they did as a documentation project post-mortem for lessons learned, such as solicit usability feedback from the customer using the document or to identify how the documentation work practices impacted the process and the product. The answer was, “Oh we did not do anything like what you suggested. The document must have worked because we had our meeting with the agency. We just moved on to the next document.” I asked if they got what they wanted out of the meeting. The answer was a categorical no. “We did not get an answer to our most important question as we had placed it as 8 of 8 in the queue. We ran out of time to address that question.”

I asked how uniform their documentation practices are for the creation for briefing packages (they will generate such packages numerous times in a given year for various development projects). Response was “We have no set approach, so each briefing package will be generated utilizing variable methods and processes.”

How they could be surprised with a low rating for the sophistication of their documentation practices is the interesting question for me. Where comes the comfort with such outcomes? In part, I think, it is due to erroneously assigning the sophistication in conduct and analysis of science as carrying over to documentation work practices.

Originally published on our Knowledge Management blog

Critical Thinking Skills

I am doing some work on how to use visual thinking in the collaborative work environment and got into an interesting discussion with the client regarding critical thinking skills,  the subtle differences for application of these skills in the business place of drug and device development versus the academic place, and how well prepared people may be for the demands of problem-solving in the workplace.

As a result of the conversation, I got looking for some reference materials regarding critical thinking and methods to improve these skills.  I came across this blog by Tim van Gelder: "Bringing Visual Clarity to Complex Issues" and his post regarding how critical thinking skills are acquired. Check it out.........a very interesting read. I am quite interested in van Gelder's comments regarding "situated cognition" where he states:

CT [critical thinking] is deeply tied to particular domains and can only be acquired through properly “situated” activity in each domain.  Extreme versions deny outright that there are any generic CT skills (e.g. McPeck).  Moderate versions claim, more plausibly, that increasingly general skills are acquired through engaging in domain-specific CT activities.

Originally published on our Knowledge Management blog

The importance of understanding the reader and the need to be informed by reading theory

In thinking about the ExLPharma conference where I spoke two weeks ago on review, I talked for some time about the importance of reviewers understanding their readers and the need to be informed by reading theory so as to become a truly good reviewer. My comments were largely well received by the group attending the conference and, for most of the points I raised regarding reading theory, were truly novel for them. I came away from the conference with the notion that few people actively engaged in creating business documents have invested time in thinking about what regulatory readers actually “do” with their documents and how they actually read these mission-critical documents.

Given that most people inspect a document for accuracy tells me that the prevalent view regarding reading is “if we get the numbers and the words right, then we are good to go and surely everyone will understand what we mean.”

I remain perplexed as to why this view is so uniformly applied. I am even more perplexed why some people I cross paths with in my client settings struggle to accept the notion that readers construct a meaning that they personally create from a text, so that "what a text means" can differ from reader to reader. Readers construct meaning based not only on the visual cues in the text (the words and format of the page itself) but also based on the knowledge readers already have stored in their memory. This pre-existing knowledge readers bring with them as they encounter a text is very potent and not much appreciated by many I work with across the life sciences.


Originally published on our Knowledge Management blog

6 Questions Regarding Medical Writing as a Profession

A follow-up to some earlier posts regarding medical writing as a profession. I have six questions I am pondering about the notion that medical writing is a profession. I welcome your thoughts on these questions.

1. Why should medical writers attend to professionalization issues? Why not?
2. Why is professional status necessary or desirable? Why not?
3. If you want to use the term professional, then who should set the standards and minimum qualifications for use of the term "professional"? How should the standards be established? Does an AMWA or EMWA certification make you a professional?
4. What can be learned from other professions that have achieved a professional identity?
5. Some observers will suggest that seeking professional status is merely a form of elitism where desire is to control knowledge and restrict access?
6. What theories/practices inform medical writers as authorities and thus warrant professional status?

Originally published on our Knowledge Management blog

Proving Document Quality

You say you produce high-quality document products? Great, now prove it! Although many can recognize quality when they read it, the prospect of measuring documentation quality seems dubious to many.

I work with a great many clients where authors say they generate high quality documents, but they can only show that their documents are accurate. That is, accurate in terms of template, source data, and grammar conformance. Beyond these three inspection parameters, many regard documentation quality as inherently immeasurable. I argue that these three parameters by themselves are wholly insufficient measures of document quality and that important aspects of how documents convey meaning can be measured.

Surely they must see other metrics of value, especially when considering factors like the number of regulatory questions elicited by errors of omission and commission in their very accurate submission documents or the number of protocol amendments generated over the life of their very accurate research protocol.

Some see additional metrics as meaningful, but not for their type of documentation. In the realm of clinical development documentation, many consider their output unique and beyond measurement. I hear more than a few medical writers say, “We know our own field intimately, and everywhere we look we see shades of gray and unique situations, so measuring is not useful.” and others in clinical development say “We are unique, and your notions of quality do not apply to us.”

Still others find the prospect of measuring output impractical or suggest that even if they had data, “Against what standards could we make comparisons?”

Even easily measured attributes like accuracy are not effectively tracked. Documents are routinely verified/corrected by quality control operators, yet the output is rarely tabulated and statistically analyzed to provide a measure of writer performance. The intention is merely to ensure the document is archived as accurate in terms of template, source data, and grammar conformance.

I do not know of any pharmaceutical or medical device company that makes use of any statistical quality control techniques to track their document quality. It would be easy to apply similar principles as used in the auto industry or pharmaceutical manufacturing. The auto manufacturers turn out millions of units every year, and each company tracks manufacturing defects, but not by examining every car. Instead, they pull a few cars off the assembly line and tear them apart. Pharmaceutical manufacturers test an appropriate sample from each manufacturing lot. In both cases the products are measured against a set of well-defined acceptance criteria.

Such acceptance criteria exist for technical and scientific documents (in our work at McCulley/Cuppan we have developed such a set of criteria that we use during our training and consulting work for clients) so such quality control methods could easily be deployed.


Originally published on our Knowledge Management blog

More Regarding Merit of Peer Review

Last week the New York Times had a major article devoted to web alternatives to peer review. Actually it does not describe an alternative to peer review but rather an alternative way of doing peer review via the web. The concept is not new, but by getting major coverage by the NYT, perhaps web-mediated review is starting to get some real traction.

Way back in 2004, Gerry McKiernan, Science and Technology Librarian at Iowa State University, posted a great paper suggesting internet-based peer review alternatives: "Peer Review in the Internet Age: Five Easy Pieces."

Last point for this post, here is an interesting editorial paper: "Is Peer Review Censorship?"  written by Arturo Casadevall and Ferric C. Fang that appeared in the American Society for Microbiology. As a point of emphasis to echo comments we have made previously in this blog, I note their comment that:

The current system persists despite abundant evidence of imperfections in the peer review process. Most scientists would agree that peer review improves manuscripts and prevents some errors in publication. However, although there is widespread consensus among scientists that peer review is a good thing, there are remarkably little data that the system works as intended.

Once again, why is a community so driven by evidence, so willing to cast a closed eye to the paucity of support for the practice of peer review?


Originally published on our Knowledge Management blog