Developing Industrial Cases For Technical Writing on Campus  

At the World's Columbian Exposition of 1893, the World's Engineering Congress met and included special section, 'Division E, Engineering Education.' This division was the seed for The Society for the Promotion of Engineering Education, and one paper delivered in the section was 'Training of Students in Technical Literary Work,' evidencing early concern about engineers' education in technical writing. But concern alone did not solve the problem. Two decades later Edward D. Sabine, a terminal engineer, complained that most college graduated engineers could not even write a decent letter. And in the same year F. W. Springer, a professor of electrical engineering, spoke of the need for teaching 'engineering-English.' Fifty years ago Hale Sutherland, a professor of Civil Engineering, described how Case School of Applied Science had instituted a two-course, technical writing requirement to overcome 'the engineer's ancient weakness, his inability to speak and write effectively.' One approach to solving this problem has been cooperation. Seventy years ago C. W. Park wrote an article about the cooperative program at the University of Cincinnati, in which members of the Engineering and English Departments worked together to promote better writing; obviously the idea of teaming up is hardly new. Thirty years ago The Journal of Engineering Education published another description of a cooperative effort and just five years ago devoted an entire issue to technical writing. The need for teaching engineers to write and the difficulties in accomplishing the objective even cooperatively have been recognized for almost a century; we are still grappling with the problem.

Mair, David and John Radovich. JAC (1985). Articles>Education>Writing>Technical Writing

Developing Knowledge Base Articles

A short article that offers some tips on writing articles for a knowledge base, whether internal or client facing.

DMN Communications (2008). Articles>Documentation>Writing>Technical Writing

Developing the Specification for a Document

Between 25-30 percent of the overall writing time is typically devoted to developing the document specification, meaning how the document will be formatted and actually present the information. This is true even when the organization has a style guide with a prescribed format, but no “standard” for documentation overall. Although this may seem an inordinate amount of time and effort on the front end, before getting any information onto the paper, it is far more cost-effective than spending unplanned time rewriting and reformatting the document late in the production process.

Tech-Writer. Articles>Writing>Project Management>Technical Writing

Dirty Battles in the Trench: Is It Wise to Use Real Materials for Editing in a Technical Writing Class?  

The use of real materials in a technical writing class involves both advantages and drawbacks. Use of real materials makes the class relate well to the work environment, improves self-esteem, critical thinking, and student motivation. Drawbacks include the problem of finding materials, a lack of course continuity, a lessening of use of the class text, and legal implications. Overall, the use of real materials for classroom editing is recommended.

Stibravy, John A. STC Proceedings (1993). Articles>Education>Writing>Technical Writing

Discovering the Pedagogical Paradigm Shift in Technical Writing  

For my dissertation, I am analyzing technical writing textbooks from the early 1900s to the present to determine whether technical writing pedagogy has undergone or is undergoing a paradigm shift. When I began this study, my hypothesis was that technical writing pedagogy, like composition and rhetoric pedagogy, has shifted from the product orientation to the process orientation. Textbooks that are product oriented emphasize the study of examples or models, and textbooks that are process oriented emphasize the study of the writing process. Now that I have completed my study and am in the process of analyzing the results, my hypothesis is that technical writing pedagogy shifted from a product orientation to a combined product and process orientation.

Jeansonne, Jerold. STC Proceedings (1995). Articles>Education>Writing>Technical Writing

Distributed or Centralized: How to Maintain Quality When They Keep Reorganizing Your Organization  

Is there a 'best' way to organize technical publications? One central organization? Many small organizations per business unit? Communicators distributed through the development teams? Discuss the pros and cons of organizational structure and its relationship to quality.

Hackos, JoAnn T. STC Proceedings (1998). Articles>Writing>Quality>Technical Writing

Do Technical Writers Need an International Standard for English-Language Spelling?

He demonstrates how ministers of state who speak different languages often choose English as the most convenient language of communication. He cites the 11-nation European Central Bank in Frankfurt as a typical organization that works only in English. And he notes that many of the journals published by respected international organizations such as the Pasteur Institute also are published in English. TC-Forum is another example.

Blicq, Ronald S. TC-FORUM (1999). Articles>Style Guides>International>Technical Writing

Boilerplate

The SMEs had a choice between two sets of tables they could use to input key product data. If their part of the project used items from the A list, they were supposed to use table A. If their part of the product used items from the B list, they were supposed to use table B. In almost every case, the SMEs used the wrong table, leaving gaps where their information did not conform to the columns of the tables.

Hewitt, John. Writer's Resource Center (2005). Articles>Writing>Technical Writing>SMEs

The Documentation Scene

Funny thing, documentation. Ought to be easy enough, surely? So why the disappointing results? What IS the elusive spark which distinguishes the professional author from others who put their hand to the pen (keyboard)?

Mobbs, John. ISTC (2002). Articles>Documentation>Writing>Technical Writing

Documentation Solutions for Complex Tools: Task-Based Design at the Cross Roads  

For most of the technical writing community, task-based documentation has become the panacea for presentation of end-product document (in any of its myriad forms including traditional linear manuals and online help). We believe, however, that applying this method to a complex tool, (for example, a software tool without a Graphical User Interface), challenges the task-based approach.

Swallow, Lisa and Matt Laney. STC Proceedings (2004). Articles>Documentation>Writing>Technical Writing

Does Having a Blog Make You a Writer?  

For the techno-savvy TechRepublic member, writing in some form or fashion is an almost daily occurrence. But how effective is your communication? In this interview, author Barry Rosenberg shares his thoughts about the current state of technical writing skills.

Kaelin, Mark. TechRepublic (2005). Articles>Interviews>Technical Writing>Blogging

Downsizing Documentation: Meeting the Challenge  

The redesign of the Microsoft Windows operating system along with a shrinking page count and Help file-size allocation, presented Windows User Education with a unique opportunity. We not only redesigned our entire documentation model, we also changed and improved our authoring tools. And, along the way, we changed how we did our work.

Bloch, Peggy, Phyllis Levy, Kimberly A. Parris and Gayle Picken. STC Proceedings (1995). Articles>Documentation>Technical Writing>Minimalism

Drawing on Technical Writing Scholarship for the Teaching Of Writing to Advanced ESL Students--A Writing Tutorial    

The article outlines the technical writing tutorial (TWT) that preceded an advanced ESL writing course for students of English Philology at the Jagiellonian University. Having assessed the English skills of those students at the end of the semester, we found a statistically significant increase in the performance of the students who had taken the TWT in comparison to the control group who spent the time of TWT doing more traditional exercises. This result indicates that technical writing books and journals should be considered as an important source of information for teachers of writing to ESL students.

Zielinska, Dorota. Journal of Technical Writing and Communication (2003). Articles>Education>Writing>Technical Writing

The Dual Mission of the Community College and Implications for Technical Writing Instruction  

Technical writing education in the community college is complicated by the need to serve multiple populations, including traditional college students, vocational/certificate students, and community businesses. At Heartland Community College (HCC), the Corporate Education Department serves the needs of businesses by providing workshops of varying lengths and content areas. At the same time, the Writing Program and the English Department serve the needs of traditional and vocational students through writing courses in composition, technical writing, and business writing. Since each department espouses different philosophies and is addressing the needs of a different audience, technical writing instruction varies across the College. Rarely does one course design affect the other, yet I believe that conversations between departments could help the College resolve some of the contradictions that accompany its dual mission.

Kratz, Stephanie. CPTSC Proceedings (2000). Articles>Education>Writing>Technical Writing

Early Involvement: Writing at Product Design Time  

Lead writing is a process that moves the information development cycle into the product development cycle. Writers and programmers work together from the beginning to produce both code design and supporting information. This process ensures that information developers can actively participate in design, and programmers can contribute to supporting documentation. Both groups gain an appreciation for each other's perspective, expertise, and skills, producing a more customer-oriented product.

Coppola, Carolyn M. STC Proceedings (1993). Articles>Documentation>Writing>Technical Writing

Editing Modular Documentation: Some Best Practices

Much has been said about the creation of modular documentation - from content management systems, to information architecture, to delivery forms, to the usability of modular content (content being easier to use, easier to understand, and easier to find), and so on. However, not much has been said about the editing of that content, and what the editor's role is in such an environment.

Corbin, Michelle and Yoel Strimling. WritersUA (2008). Articles>Documentation>Technical Writing>Technical Editing

Editing Your Own Documentation  

Technical writers sometimes fall into the trap of thinking that the user is stupid. I have often heard technical writers say things like 'well, if the user can't figure that out, maybe he’s in the wrong job!'

Docsymmetry (2003). Articles>Documentation>Editing>Technical Writing

Editing Yourself

Here are some tips that helped me edit my own writing.

Leigh, Heather. Crazy for Words (2007). Articles>Editing>Writing>Technical Writing

Effective Outlining: Designing Workable Blueprints for Writing  

Save time and increase your credibility by creating an effective outline. Hart's article discusses three important steps in designing an outline.

Hart, Geoffrey J.S. Intercom (2006). Articles>Writing>Technical Writing

Review: The Elements of Technical Writing  

The elements of technical writing includes a basic definition of technical writing--'writing about subjects in technical disciplines'--as well as a high-level outline of the book. Few prefaces contain as thorough a summary of changes as Pearsall offers. The summary of changes in this second edition acknowledges the necessity for current information in the changing technical writing arena, listing several specific changes from the first edition.

Williams, Jocelyn Crump. Technical Communication Online (2003). Articles>Reviews>Writing>Technical Writing

Eleven Tips for Writing Incredibly Useful Procedures

Procedures are the meat and potatoes of technical writing. They help users get the job done. Follow these tips for writing clear and useful procedures that your users will appreciate.

HelpScribe (2008). Articles>Documentation>Policies and Procedures>Technical Writing

Removing Unnecessary Words

Using an extended example, this article shows how it is possible to reduce the number of words in a text and at the same time increase readability.

Unwalla, Mike. TechScribe (2003). Articles>Writing>Technical Writing>Minimalism

The Elves and the Shoemaker—We Don't Wear No Pointy Hats  

When technical communicators are part of a development team, we can do much more than write manuals. Our analysis and communications skills, user perspective can help launch a project team into productivity. We have a unique skill set which enhances the productivity and quality of the development process. By involving us early, we can assume technical communications tasks that developers otherwise perform. This exposure gives us a broader and deeper understanding of that which we communicate. Our involvement means better communication; with users and team members, and in deliverables and development processes.

Mazur, Sue and Jamie A. McCanless. STC Proceedings (1994). Articles>Documentation>Writing>Technical Writing

Embedding Linked Images in a Word Document

I wish Flare gave me an option before creating the printed documentation: embedded or linked images. I went through a lot of rigmarole before finally figuring out how to get the images embedded so I could share the document.

Lentz, Michelle. Write Technology (2007). Articles>Writing>Technical Writing>Madcap Flare

Empathize with the Writer    

It is my firm belief that every technical writer is passionate about her work and would put in her best efforts to deliver high quality. If you are a manager or an editor and are shaking your head in disagreement, think again. Why would someone want to submit a work of poor quality?

Lawrence, Prema. International Journal for Technical Communication (2006). Articles>Writing>Project Management>Technical Writing