Articles>Collaboration>Writing

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.

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.

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.

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.

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.

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.

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.

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.

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.

Is Lone Writing Becoming a Team Sport?

Larbi discusses the transition—including advantages—that many lone writers face as globalization becomes more prevalent and individual consultants transform into lone writer teams.

Social Media 101: Now Everyone's a Technical Writer

Free and cheap tools (blogging software, cheap digital cameras) have made "many-to-many" communication possible. This is sometimes called the "rise of the creative class." People are shifting from being consumers to creators.

How to Entertain Technical Writers

I've often wondered what it would be like to throw a party and invite only technical writers. While we are a diverse bunch, we definitely share some common interests, pet peeves, etc. If you ever happen to arrange such a gathering, here are a few ideas for keeping your guests entertained.

The Role of Double Agents in Writing Projects

Double agents on writing teams provide benefits to both product developers and technical writers with their unique skills and perspectives. You'll be more likely to get the information you need when you need it because your double agent has already set the stage for success. Learn the benefits of having a double agent working with technical writers as a part of the product development team. Discover valuable secrets never before divulged to the public that you can use to work with your product developers. Take out your magnifying glass and look for the clues.

Reviewing a Peer's Work

If we've been asked by a peer to review his or her work before it is sent out to be scrutinized by the world, our job is to neither edit nor rewrite the information. Our job is to give helpful, specific feedback about where the information communicates well and where it needs work. The more we understand about how to review a peer's work effectively, and how doing this is different from editing, the better feedback we can provide.

Storyboarding and Collaboration

For technical communicators, storyboarding is a path to collaboration with team members and users. Collaboration and storyboarding help technical communicators get new ideas, find new structures, and discover new modes of expression. In this workshop, you will learn about storyboards and how to develop them. You will also participate in exercises on conducting and collaborating on a storyboard review and on writing a storyboard specification. You will discover how collaboration helps create the context, organization, and design of a document through the use of storyboards.

Plural Authorship and the Thesis: What Graduate Students Tell Us About Collaborative Writing

Most graduate students at the Air Force Institute of Technology's School of Logistics and Acquisition Management write their theses as a team project. However, the Institute has gathered no systematic information about how students manage their collaborative thesis-writing processes. This research gathers descriptive quantitative and qualitative data from 1992 graduates concerning how they composed the teem-authored thesis. In addition, this research extends the collective vocabulary concerning collaborative writing, particularly when applied in academic settings.

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.

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.

The Hidden Relationship Between Project Managers and Technical Writers

Want to know the secret to better quality documentation and improved software design? Will Kelly outlines how the key is an effective relationship between project managers and technical writers.

Changing the Center of Gravity: Collaborative Writing Program Administration in Large Universities

Technical communication practices have been changed dramatically by the increasingly ubiquitous nature of digital technologies. Yet, while those who work in the profession have been living through this dramatic change, our academic discipline has been moving at a slower pace, at times appearing quite unsure about how to proceed. This article focuses on the following three areas of opportunity for change in our discipline in relation to digital technologies: access and expectations, scholarship and community building, and accountability and partnering.

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.

Now That You've Got a Double Agent, What Do You Do With 'Em?

Having demonstrated the importance of acquiring a double agent for writing projects, we now want to explain the best ways to successfully indoctrinate a double agent. This paper will help you prepare for, orient, train, and become a mentor for a double agent to help make him or her an effective member of your writing team.

Riffing for Originality

Riff is a metaphor from jazz to describe a form of improvisation in which one musician borrows and builds on the musical phrase of another.

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.

Being Personal isn't About Being Their "Buddy"

I have written often about the value of writing online in a personal voice. In particular, emails and newsletters lend themselves to a genuine, personal tone.

Same Tools, New Ideas: A Real-Life Example of Information Sharing and Reuse

Sharing information between writers in a team is a great way to maximize resources and minimize cost.

Strategies for Peer-Reviewing and Team-Writing

When you peer-review other people's writing, remember above all that you should consider all aspects of that writing, not just--in fact, least of all--the grammar, spelling, and punctuation.

Collaborative Document Editing with svk

Say you have a document that needs to be presented in two languages and you are the translator. While the translation is in progress, someone revises the original master document. This means you now might be working with an outdated paragraph or one no longer present in the master version. This article tries to map this problem to parallel development, which version control systems solve with the branch and merge model. You will also see how svk helps you maintain translated documents easily.

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.

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.

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.

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.

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.

Learning the Fine Art of Reviewing

If you asked me what the most painful part of being a technical writer is, my answer would be: 'Getting reviews on time. Getting good feedback and inputs on your work.' For me technical writing has been very pleasurable because I hardly got any review comments. My morale has therefore been very high. Project managers, developers and others are so busy trying to come up with good software (read trying to fix all the goof-ups and bugs!) that they usually tend to give documentation lesser importance. User manuals, who reads them anyway? We do not have time for it!

The Role of the Editor in the Technical Writing Team

Editing today covers far more than printed materials. In this discussion, I am assuming a technical editor may be required to deal with: printed materials (for example, books, pamphlets, quick reference cards); electronic (for example, online documentation, online help, web pages); video scripts; computer-based training materials. I am also assuming that the audience for the material being edited is not comprised of other technical people; or if it is, the editor is not the person responsible for ensuring the technical accuracy of the material.

Many Heads Make Work Right

Writing is popularly considered a spontaneous exercise, and often is. Spontaneous writing, however, does not always result in high quality results.

Group Work and Collaborative Writing

Working with a group on a project can be a pleasure: responsibilities are equitably divided, the tedium of work is punctuated by conviviality and commiseration, and large problems dissolve under scrutiny from a variety of perspectives. Working with a group can also be frustrating, the seemingly indirect and digressive, as well as anxiety-ridden and inconvenient. But still, the product of group work has better odds for success than does the product of an individual.

The Influence of Gender on Collaborative Projects in an Engineering Classroom

Using a qualitative approach to data collection and analysis, this article discusses some of the findings from a larger study on collaboration and the role of gender. Here, we profile three student engineering teams as they participate in processes leading to the submission of a report for a team-based technical communication course. While some theorists suggest that gender can play a significant role in achieving a successful team dynamic, our study only partially supports that claim. A synopsis of two women from two predominantly male teams reveals glimpses of what the literature describes as traditional gender-linked behaviors by both men and women, but the all-female team does not conform to stereotypical patterns and their behaviors call into question the existence of these interactional styles. We suggest that factors other than gender and independent of a team’s gender composition—such as team commitment and a strong work ethic—exert a greater impact on collaboration. Nevertheless, the study does caution against assigning women to predominantly male teams since, when a team’s social structure is mostly male, traditional gender-linked interactional behaviors as well as manifestations of the culture of engineering are more likely to emerge. Overall, the study underlines the importance of examining specific face-to-face interactions to see how behavior is situationally produced in order to more fully understand the interactional strategies open to individuals.

The Issue of Quality in Professional Documentation: How Can Academia Make More of a Difference?

This article recommends strategies academics can use to contribute to an issue of great interest in industry: how best to define, measure, and achieve quality documentation. These strategies include contextualizing quality definitions, advocating the use of multiple quality measures, conducting research to identify specific heuristics for defining and measuring quality in particular workplace contexts, and partnering with industry to educate upper management about those heuristics and the benefits of promoting technical communicators to the strategic role of organizational “gatekeepers of quality.”

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.

Extending Your Tech Writing Skills: Pitching a Newspaper Column Idea

Before pitching a column idea to your local newspaper editor, take time to examine whether becoming a columnist is right for you. In taking on a newspaper column, you not only take on a long-term commitment, but you also establish a responsibility to people in your own community. So, to begin, you might read Extending Your Tech Writing Skills: Becoming a Columnist, which identifies considerations for becoming a columnist. If you decide that becoming a columnist does suit your interests and goals, then the following tips and ideas can help you land a column with your local newspaper. As you'll see, examining and refining the topic, overcoming the competition, using a creative approach, and following up appropriately can help.

Freelance Article Writing: Tips for Establishing and Maintaining Good Relationships with Magazine Editors

While writing attention-grabbing, informative queries--a much-covered topic in the freelance writing arena--is important in landing assignments, don't overlook one important aspect that can help you continue landing assignments time after time: Establishing and maintaining good relationships with the editors you work with. This article offers advice, how-to and why-to information, and techniques to apply throughout the publishing process that can help you build good relationships with magazine editors. Although the following sections provide specific details and steps, the message is simple: A little understanding, consideration, and effort go a long way.

E-Mail Tutoring, A New Way To Do New Work

Although writing centers have used computers for over a decade now, they have used them primarily in autotutorials (computer-assisted instruction) and word processing. These applications reflect the influence of the process movement in composition studies and the writing center's commitment to the individual writer. Yet as the field moves towards the social in its scholarship and its writing technologies, writing centers might look towards e-mail to seek out new forms of tutor-student collaboration. The essay describes an experiment with e-mail tutoring and explores implications of new working conditions for online tutors.

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

Documenting Contributory Expertise: The Value Added by Technical Communicators in Collaborative Writing Situations

Technical communicators frequently collaborate in workplace projects and bring a host of different kinds of expertise to this collaboration. Yet the understanding of communicators’ expertise among managers and subject matter experts is grounded in a view of writing as a finished product and authorship as singular. This article documents many different kinds of 'contributory expertise' employed by writers collaborating to produce articles for publication. Expertise in research, textual composition, visual composition, as well as other kinds of expertise garnered on previous projects is often brought to collaborative projects. Often emerging and developing as a function of collaborative work is expertise in framing the project, conducting review processes, and assessing outcomes. These categories are discussed in some detail to provide practicing communicators with ideas for documenting expertise in their specific workplaces, to provide students with ideas for developing expertise in various areas, and to prov

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.

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.