Conducting Effective Team Technical Reviews

Mention team technical reviews to a group of tech writers and chances are good that you will either get a loud, collective groan, or the group will vie to tell the best review horror story. On the one hand, technical reviews are a vital part of our jobs because they help us to produce high quality product documents. On the other hand, technical reviews gone wrong are the bane of our existence. The good news is that we have the power to conduct consistently effective technical reviews. This article summarizes why we do reviews and what often goes wrong in reviews, and then summarizes steps to take before, during, and after technical reviews that can help you conduct effective team technical reviews. Although your process and team may differ from what's described here, you can apply the information in part or in whole to improve your current review process.

Brown, M. Katherine 'Kit'. TECHWR-L (2008). Articles>Project Management>Collaboration>Assessment

Content Analysis as a Best Practice in Technical Communication Research    

Content analysis is a powerful empirical method for analyzing text, a method that technical communicators can use on the job and in their research. Content analysis can expose hidden connections among concepts, reveal relationships among ideas that initially seem unconnected, and inform the decision-making processes associated with many technical communication practices. In this article, we explain the basics of content analysis methodology and dispel common misconceptions, report on a content analysis case study, reveal the most important objectives associated with conducting high quality content analyses, and summarize the implications of content analysis as a tool for technical communicators and researchers.

Thayer, Alexander, Mary Evans, Alicia McBride, Matt Queen and Jan Spyridakis. Journal of Technical Writing and Communication (2007). Articles>TC>Assessment

Contextualize Technical Writing Assessment to Better Prepare Students for Workplace Writing: Student-Centered Assessment Instruments    

To teach students how to write for the workplace and other professional contexts, technical writing teachers often assign writing tasks that reflect real-life communication contexts, a teaching approach that is grounded in the field's contextualized understanding of genre. This article argues to fully embrace contextualized literacy and better teach workplace writing, technical writing teachers also need to contextualize how they assess student writing. To this end, this article examines some of workplaces' best assessment practices and critically integrates them into an introductory technical writing classroom through a method called student-centered assessment instruments. This method engages students, as workplaces engage employees, in the assessment process to identify local requirements for writing tasks. Aligned with theory and practice, this method is not only an effective classroom assessment method, but becomes an integrated part of students' genre-learning process within and beyond the classroom.

Yu, Han. Journal of Technical Writing and Communication (2008). Articles>Education>Technical Writing>Assessment

Control Charts, Quality Assurance, and Information Development  

The purpose of this paper is to explore a method that allows information developers to measure the quality assurance being invested in the products they create. A successful project achieves a balance between the time it takes to produce information, the associated cost, and the quality of the end product.

Murphy, Stephen W. STC Proceedings (1993). Articles>Information Design>Assessment

Controlling Quality, Controlling Costs  

By developing a strategic plan, finding out if we are producing the right learning products in the most efficient way, and changing to a minimalist document design, we can meet the challenges of the present business environment. Since many of us are now expected to produce more with less while maintaining or improving the quality of the products we produce, we need to manage our function better. By following the suggestions in this paper, you will be able to: communicate the importance of your function; get control of your function; demonstrate how you add value to your companies' products.

Mattingly, William A. STC Proceedings (1993). Articles>Management>Quality>Assessment

Creating Communication Modules for an Engineering Enterprise Initiative: Programmatic and Rhetorical Considerations  

Our discussion will consider the ways in which we conceptualized an engineering enterprise initiative’s 'communication component,' alternate ways in which it could be conceptualized, and our efforts to maintain pedagogical and programmatic integrity while addressing the very practical needs of this ABET-driven curricula change. We feel that these questions must be addressed if we are to truly participate in a 'systemic change' in engineering education and its integral communication challenges.

Aller, Betsy and M. Sean Clancey. CPTSC Proceedings (2000). Academic>Education>Assessment>Engineering

Criteria for Focused Data Collection  

The objective of this task is to propose and validate a mechanism whereby projects can identify their needs for software measurement data and focus their data collection activities using a minimum standardized set of software measures. The purpose of this strategy is to evolve a process that will enable NASA projects to tailor with their data collection activities to their unique needs for effective management control indicators, but also encourages consistent data collection that will facilitate statistical analysis across NASA domains.

Wilson, William M. NASA (2001). Articles>Usability>Methods>Assessment

Crossing the Boundaries of Instruction: Assessing Web-Based Courses

We recently conducted survey research to discover students' responses to our web-based courses and online programs. We wanted to know their reactions to the course materials, teaching methods, interactions with faculty and other students, as well as their own competence in the particular subject area following such as course. While we are discovering that students are generally satisfied with all aspects of the courses, they express valid and noteworthy concerns.

Tovey, Janice and Michelle F. Eble. CPTSC Proceedings (2003). Articles>Education>Assessment>Online

Deciding the Future: Balancing Risks, Costs, and Benefits Fairly Across Generations  

Explanations are presented of four principles for intergenerational decision-making and initial guidelines for application: trustee principle, sustainability principle, chain of obligation principle, and precautionary principle. The principles need to be used as a set and include certain actions and public discussions under specific circumstances. Some examples are: comprehensive analysis of possible risks and beneficial or damaging consequences of actions, public discussion of the results of these analyses with those who may be significantly affected before decisions are made, and continuous examination of actions or decisions taken by previous generations to evaluate their continued validity and making adjustments if previous decisions are no longer valid.

U.S. Department of Energy (1997). Articles>Risk Communication>Assessment

Decision Models for Comparative Usability Evaluation of Mobile Phones Using the Mobile Phone Usability Questionnaire (MPUQ)  

A comparative usability evaluation was performed using various subjective evaluation methods, including Mobile Phone Usability Questionnaire (MPUQ). Further, decision-making models using Analytic Hierarchy Process (AHP) and multiple linear regression were developed and applied. Although the mean rankings of the four phones were not significantly different across the evaluation methods, there were variations across the methods in terms of the number of rank orderings, preference proportions, and methods to select their initial preference. Thus, this study provided a useful insight into how users make different decisions through different evaluation methods. Also, the result showed that answering a usability questionnaire affected a user's decision-making process for comparative evaluation.

Ryu, Young Sam, Kari Babski-Reeves, Tonya L. Smith-Jackson and Maury A. Nussbaum. Journal of Usability Studies (2007). Articles>Usability>Assessment>Surveys

Defining Benchmark Questions for Great Results

Part of the challenge of determining the questions to ask during benchmarking is to match the questions to the purpose of the study and the outcomes you are trying to achieve. Below is a breakdown of some of the issues regarding benchmarking questions that need to be addressed before beginning a benchmarking exercise.

Sinickas, Angela D. Sinickas Communications (2002). Articles>Management>Communication>Assessment

The Delicate Art of (Web) Design Critique

Since I tend to hang around on various web-related mailing lists, I often see numerous requests for design critiques. Increasingly, this leads me to wonder about the process of critiquing other people's design. It's quite one thing to criticize someone's code; one can argue the merits or not of being a stickler about standards compliancy, or using CSS, or whatever. But design is more personal than writing code. (Writing on its own is also very personal, but that's not the topic here.) How do you constructively critique someone's work without being taken the wrong way? How do you accept criticism without feeling hurt or angry? Here are just a few ideas, gathered from observations and comments from others.

Itoh, Makiko. Digital Web Magazine (2000). Design>Web Design>Graphic Design>Assessment

The Dell Computer Experience: From Maturity Model Assessment to Strategic Planning    

Dell Computer Corporation's Information Development area was tasked with benchmarking itself with other similar areas in the industry. This case study details the evolution of this requirement to the fundamental need for a strategic plan, and how the requirement was met. The steps begin with gaining an understand of strengths and weaknesses as compared to the industry and end with goals for using the strategic plan to strengthen the area.

Rosenquist, Deborah J. Technical Communication Online (1997). Articles>Information Design>Assessment

Demand Modeling, New Mode Problems, and the $64 [sic] Question: Technological Utopianism in America's Race to Develop High Speed Rail Technology      

This article analyzes reports describing a proposed MagLev rail system, reports which employ idiosyncratic rhetorical devices to argue for funding. The analysis discusses ethical and rhetorical dilemmas which face writers seeking funding for 'new mode' problems.

Sauer, Beverly A. IEEE Transactions on Professional Communication (1993). Design>Information Design>Assessment

Demonstrating Effectiveness and Value: A Process for Evaluating TC Products and Services    

This article attempts to provide a framework that can be used to assess the effectiveness and value of technical communication products, and suggest how we can use it to help our clients perceive the value of those products. The framework is adapted from a similar framework initially developed by Kirkpatrick for trainers. First, the article presents the Kirkpatrick model and identifies the limitations in using it to assess the quality and value of technical communication products. Next, an adapted model for assessing the quality and value of technical communication products is presented. Last, the article addresses a series of issues related to collecting data about quality and value, such as when to collect the data, how to ensure its credibility, and how to report it to others. This framework may help us develop a widely used and accepted methodology for assessing the quality and effectiveness of technical communication products.

Carliner, Saul. Technical Communication Online (1997). Articles>TC>Assessment

Design, Results, and Analysis Assessment Components Nine-Course Program    

The case for assessment of college writing programs no longer needs to be made. Although none of us would have chosen the words, we all have come to accept the truth of Roger Debreceny’s words: the 'free ride' for America’s colleges and universities is indeed over (1). All writing programs face difficulties in selecting the means for the most effective evaluations for their individual programs. Key concerns include how appropriately, practically, and cost effectively various assessment tools address this problem.

Carson, J. Stanton, Patricia G. Wojahn, John R. Hayes and Thomas A. Marshall. LLAD (2003). Articles>Education>Writing>Assessment

Designing Design Education

Designers today are involved in the development and design of new products and their interactions, software, virtual identities, web sites, strategic plans, wearable computers, digital libraries, games, and interactive exhibitions. The old monikers of graphic and industrial design aren't descriptive of the new fields of practice and research that are being explored today. These disciplines in fact have come to realize that they do not own the word `design.' The activity of design, as described by Simon (1969), is being practiced by a host of disciplines that include engineering, computer science, information systems, professional writing, and business. We encounter job titles such as software design, engineering design, human-computer interaction design, and systems design, to name a few. If design is so pervasive, who, then, is a designer and how is s/he educated?

Boyarski, Daniel. SIGCHI Bulletin (1998). Articles>Education>Instructional Design>Assessment

Developing and Assessing Oral Communication Competence

The importance of oral presentations in professional environments related to Computer Science is unquestionable. Therefore, oral and writing skills are included in the set of competences to be developed by students through the application of recent academic initiatives for Computer Science degrees in an international context. This article describes activities performed at Universidad Carlos III de Madrid aimed at the development of presentation skills in students. This initiative is based on the application of learning activities in combination with the delivery of different presentations that the students themselves evaluate. Results show a significant competence improvement and very satisfactory acceptance results from the students.

Garcia, Angel, Fernando Paniagua, Juan Miguel Gomez and Ricardo Colomo. International Journal for Technical Communication (2008). Articles>Education>Presentations>Assessment

Developing Customer-Driven Quality Measurements For Documents  

This paper serves as a description of the demonstration on developing customer-driven quality measurements for documents. Originally presented as a workshop at the 1993 STC Conference in Dallas, the content was modified based on participant evaluations. In addition, the format was changed to a demonstration session to allow for a more flexible presentation method based on participation and time constraints. The session will use as many hands-on exercises as possible to reinforce its objectives.

Fisher, Charles D., Jr. STC Proceedings (1994). Articles>TC>Assessment>User Centered Design

Developing Heuristics for Web Communication: An Introduction to This Special Issue    

This article describes the role of heuristics in the Web design process. The five sets of heuristics that appear in this issue are also described, as well as the research methods used in their development. The heuristics were designed to help designers and developers of Web pages or sites to consider crucial communicative aspects of Web site design. Also previewed is a sixth article that presents a framework for characterizing and analyzing the broad variety of heuristics that are available for Web designers.

van der Geest, Thea and Jan H. Spyridakis. Technical Communication Online (2000). Design>Web Design>Assessment>Heuristic Evaluation

Documentation and Training Productivity Benchmarks    

Investigates how computer-industry companies create end-user documentation and training materials, and how they measure productivity. Describes results of interviews of eleven managers of publications or training departments.

Barr, John P. 'Jack' and Stephanie Rosenbaum. Technical Communication Online (2003). Articles>Documentation>Assessment

Documentation Metrics: What Do You Really Want to Measure?  

Examines several metrics--systems for measuring production and production standards--to determine their value to technical communicators. He argues that qualitative metrics are more meaningful than quantitative ones.

Le Vie, Donald S., Jr. Intercom (2000). Articles>Documentation>Assessment>Heuristic Evaluation

Documentation Quality Metrics

To implement any continuous improvement process, you have to measure your progress. This is where metrics come in. Have you been struggling to create a process for measuring your technical documentation? If so, this article provides the information you need to get started.

Cohen, Jules. Carolina Communique (2004). Articles>Documentation>Assessment

Does Your CMS Vendor Have Product Expertise?

Choosing a content management system (CMS) is not just about finding the product with the right functionality. It's also about dealing with a vendor who can support your needs for the lifetime of the solution. This briefing explores the way most CMS vendors have evolved, what this means for the way they work, and what you should be looking for when purchasing a solution.

Robertson, James. Step Two (2007). Articles>Content Management>Assessment