Strategies for Winning Recognition: Building a Visible, Viable, and Valuable Documentation Team  

Technical writing teams can improve their standing within their organizations. The purpose of this presentation is to share our experiences at Mirant where we've achieved recognition and respect as a vital internal service to the IT department and, increasingly, to the rest of the company.

Harkness, Holly E. STC Proceedings (2003). Articles>Documentation>Collaboration>Technical Writing

Teaching Technical Writing Through Student Peer-Evaluation    

Individual students in two different sections of an undergraduate civil engineering laboratory were tasked with preparing three professional-quality laboratory reports. The teaching assistant and/or instructor used established criteria to grade the first two reports prepared by students in one section. The first two reports prepared by students in the other section were peer evaluated by assigned fellow students within the same laboratory section using identical grading criteria. The peer evaluated section had a higher class average than the teaching assistant/instructor graded section on the fist two reports. The third report prepared by students from both sections was graded by a professional educator/architect without knowledge of a student's class section. The peer evaluation students also had a higher class average on the third report, suggesting that the peer evaluation process may have positively contributed to those students' writing skills.

Jensen, Wayne and Bruce Fischer. Journal of Technical Writing and Communication (2005). Articles>Education>Technical Writing>Collaboration

The Team Approach to Writing Policies and Procedures  

Although many companies claim to have working teams within their corporate structure, it may be difficult to use the same approach for writing documentation. With the demands for controlled documentation to meet quality standards, involvement in policy/procedure writing is an important factor in developing a sense of ownership and commitment to maintaining a document control system. A team approach to writing procedures may involve more time, but the results are operations consensus, improved writing skills, and a boost of professional confidence.

Whitmer, Diane L. STC Proceedings (1996). Articles>Documentation>Technical Writing>Collaboration

Technical Assistance for Writers in the Workplace: Some Heuristic Uses of Professional Writing Techniques in a Multiauthor Writing Process     

Linda Flower's work serves as the basis for devising writing technical assistance in three case studies of multiauthor reports. One major barrier to audience-based writing, planning—and, hence, producing readable text—is the writer-based structure embodied in a project's work program. Writing technical assistance can help displace this structure by various means, including collaborative writing. But the interaction between the two activities basic to writing—creating specific audience-based goals and devising a new hierarchical structure for content knowledge—remains unclear in theory and in practice.

Baker, Linda. Technical Communication Online (1996). Articles>Collaboration>Workflow>Writing

Technical Writer/Subject Matter Expert Interaction: The Writer's Perspective, the Organizational Challenge    

Almost a decade ago, Walkowski's (1991) study of the interaction between subject-matter experts (SMEs) and technical writers focused on the perceptions of software engineers toward technical writers. Her findings gave technical writers insights on how to improve critical relationships with these organizational colleagues. This study partially replicates Walkowski's (1991) study of technical writer-SME interactions, but instead of collecting data from SMEs, we surveyed technical writers themselves. We report perceptions collected from 31 technical writers and contrast them with Walkowski's original findings, offering interpersonal and organizational recommendations for addressing tensions between these groups. By examining both the SMEs' and the technical writers' perceptions of their relationship, we are able to provide a two-sided view of a dynamic and complex interaction. We also argue that participants in the SME-technical writer interaction cannot fully alter their relationship without the strategic supp

Lee, Martha F. and Brad Mehlenbacher. Technical Communication Online (2000). Articles>Collaboration>Technical Writing>SMEs

TECHWR-L: A History and Case Study of a Profession-Specific Listserv List    

Until Spring 1993, technical communicators had few Internet resources of their own. They could find common ground in forums oriented toward specific word processing programs and other tools of the trade, but they had no place to discuss profession-specific, rather than tool-specific, issues. TECHWR-L was founded that spring, and the growth, development, and response to the list has been remarkable. Most significant, however, is the effect that TECHWR-L has had on individual technical communicators worldwide. It demonstrates that the Internet can and should be used to provide more focused and comprehensive resources to technical communicators in the future. This case study outlines the growth and development of TECHWR-L, discusses some of the more controversial aspects of the list, and outlines how TECHWR-L or some other focused forum could prove an even more valuable resource for the profession.

Ray, Eric J. Technical Communication Online (1996). Articles>Collaboration>Mailing Lists>Technical Writing

Using Customer Loyalty as a Platform for Teaching Written, Oral, and Team-Based Business Communication  

For many students, their role as customers is their most significant interface with the business world. They understand, at some level, the organizational importance of building customer loyalty for the success of companies. Building on that understanding can provide a context that amplifies their knowledge of business and reinforces the value of effective communication. Using the organizational goal of building customer loyalty as a framework for class discussion and activities gives instructors a real-world rationale that brings the world of business into communication courses. This fresh approach shows you ways to focus student writing, presentations, and group process assignments around the theme of evaluating and improving customer loyalty.

Timm, Paul R. Association for Business Communication (2004). Articles>Education>Writing>Collaboration

Wikis for Supporting Distributed Collaborative Writing  

Wikis allow distributed teams to collaboratively write and edit documents through the Internet in a shared online workspace, without the need for special HTML knowledge or tools. The flexibility of wiki technology is a boon for increased cooperative work on large team projects. However, wiki technology also complicates notions of usable design as the information architecture of a wiki site may be created on the fly by all participants rather than by a dedicated technical communicator. This paper describes the basic technology of wikis, some advantages and disadvantages, and areas of concern with regard to information design.

Wei, Carolyn, Brandon Maust, Jennifer Barrick, Elisabeth Cuddihy and Jan H. Spyridakis. STC Proceedings (2005). Articles>Collaboration>Writing>Wikis

Working with a Technical Editor

If you have never worked with an editor before, you may be wondering what to expect, and what the editor will expect from you. If you have worked with an editor before, you probably have some expectations about the relationship. Whether your past experiences were good or bad, you may be quite surprised to discover that the new editor's expectations are rather different from yours. This article looks at some aspects of the writer-editor relationship and what each of you can do to get the best results out of working together.

Weber, Jean Hollis. TECHWR-L (2002). Articles>Writing>Collaboration

Writer-Editor Interactions: What Works?  

Successful writer-editor relationships require a commitment from both parties to teamwork, open communications, and shared accountability for the success of each project. The benefits from this ejj?ort include better igformation products for users and a more congenial working environmentfor you. Equally important, your clients will develop cor@ence and trust when they see a project’s writer and editor combining their skills and collaborating on shared project goals.

Collins, William L. and Susan M.J. Lester. STC Proceedings (1997). Articles>Collaboration>Editing>Writing

Writer-Editor Relationships in Revisions

Editors, professional or otherwise, can be annoying individuals. The trick is to focus on the helpful parts of that annoyance and try to ignore the less-helpful parts.

Hart, Geoffrey J.S. Geoff-Hart.com (1995). Articles>Writing>Editing>Collaboration

Writing Across the Curriculum

The phrase 'writing across the curriculum' is relatively new, as far as I am aware. I want to examine its underlying meaning, its various administrative forms, and its implications for the faculties of colleges and of high schools to look at the theory, the practice, and occasionally the history of the notion.

Kinneavy, James L. ADE Bulletin (1983). Articles>Editing>Writing>Collaboration

Writing Programs and the English Department

A couple of years ago John Gerber, in an article in the ADE Bulletin, urged a broadened definition of 'literacy,' one that would encompass all study relating to linguistic artifacts, from the most elementary reading and writing to the most differentiated scholarship and composing. Nearly all college English departments do include much of this broad range, but the inclusion is rarely an integration. Instead, there's the English major and the freshman composition program and the creative-writing courses and, sometimes, the courses for nonmajors: film, popular culture, folklore; business and technical writing; and so forth. In large departments different faculty members may specialize in one or another of these units, and the chairman, who is supposed to be running the whole six-ring circus, can scarcely get the different sorts to talk to one another. What integration occurs begins and ends with the yearly departmental cocktail party.

Johnson, Paula. ADE Bulletin (1979). Articles>Editing>Writing>Collaboration

Collaborative Walkthrough Video

Collaborative walkthroughs are a technique that my team used while rewriting our Help and adopting DITA. We believe that we were able to improve the user experience by improving the collaborative experience.

Bennett, Miranda. On Writing (2008). Articles>Documentation>Collaboration>Technical Writing

When Trust Becomes a Characteristic Flaw in a Project

As hard as it may seem, lesson one of technical writing is to break the rules and contact the end user. Conduct a mini-ethnography. Sit with the users. Call them on the phone. Send them emails. Do not let it get to the point where you feel you must go through the PM to communicate with the end user. As hard and uncomfortable as it may be, the consequences of not talking to the end user can be crippling to your help.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Project Management>Collaboration>Technical Writing

On Collaboration

Openness is a faster route to better work. There are lots of ways of doing it, but I do think that as much as they pretend pure openness, successful OS projects all have hierarchy.

Mandiberg, Michael. Mandiberg.com (2009). Articles>Collaboration>Technical Writing>Open Source

Collaborative Authoring and Technical Writing

Writing is a complex, cyclical task. The writing task requires more than formulating text to express ideas, it involves data gathering, managing constraints, formulating intentions, planning, and revising goals. Much of the complexity is due to the management of simultaneous activities and constraints. Management of these processes can lead to 'cognitive overload', which in turn can negatively affect the quality of the text produced. With technical writing, these same issues of task complexity are applicable.

Spring, Michael. University of Pittsburgh (1997). Articles>Writing>Technical Writing>Collaboration

Networked Exchanges, Identity, Writing    

This article argues for a rhetoric of networked exchanges that focuses on the response. Working from Spinuzzi's call for a rhetoric of horizontal learning, it examines two kinds of online writing spaces in order to propose such a rhetoric. After surveying conflicting, academic attitudes regarding networked exchanges, the article proposes the response as a type of professional communication. A specific message board thread and a series of blog carnivals serve as examples of the rhetoric of response, a way that horizontal learning produces a specific type of networked writing identity. The article concludes with a call for response-based communication practices.

Rice, Jeff. Journal of Business and Technical Communication (2009). Articles>Writing>Collaboration>Social Networking

Open-Source Tech Writing: The Time is Now

We are all going to have to collaborate like never before. Everyone should select at least one area of interest and specialize as best they can. Then we will need to start meeting and sharing information. Immediately. There are several ways to do this, I believe.

Norris, Julie. 2moro Docs (2009). Articles>Collaboration>Technical Writing>Open Source

How Soon is Now?

One common complaint a lot of technical writers have is that they aren’t included early enough in lifecycle of a project. The downsides are that by the time work hits your desk you don’t have a full picture of who the customer is, why they want whatever it is you are building, and how they want it provided to them. All of which directly impacts the information being created.

McLean, Donna. One Man Writes (2009). Articles>Project Management>Technical Writing>Collaboration

Top 10 Technical Writer Annoyances

The life of a Technical Writer is far from boring. Days spent typing away at a keyboard are often disturbed by the rigours of the corporate world. I was reminded of this earlier today when one of my team, a relatively new recruit to the world of technical authoring, discovered that occasionally being kept in the dark can be annoying. In honour of this momentous occasion, I offer to you for your delectation my own top ten ways to annoy a Technical Author.

McAndrew, Colum. RoboColum(n), The (2009). Articles>Writing>Technical Writing>Collaboration

Authoring Teams Become More Geographically Dispersed 

Working with people from around the globe has become common practice for both authoring teams and technical documentation professionals. A recent survey conducted by SDL investigated the development of global authoring. The results were compared to surveys from 2007 and 2006. They reveal trends in working methods and shed light on the effects of globalization on global authoring.

Hurst, Sophie. TC World (2008). Articles>Writing>Collaboration>Teleconferencing