#13902
A case study of an experienced professor's comments on a design report in a first-year engineering class was conducted over the period of an academic year. When compared with the commenting styles of technical writing teachers, the engineering professor's comments were found to be highly directive, and thus at odds with the preference for facilitative comments that prevails in composition studies. However, differences in genre conventions explain much of the discrepancy.
Miller, Paul, Jaye Bausser and Audeen Fentiman. Technical Communication Quarterly (1998). Articles>Education>Engineering>Technical Writing
#21806
Rethinking the Evaluation of Writing in Engineering Courses 
The objective of this paper is to bring about a reevaluation of writing assessment practices in engineering classes. The authors begin by drawing rhetoric (the knowledge base of effective technical communication) and engineering together, explaining how engineering work is rhetorical. From this theoretical vantage point, the authors argue for a change in engineering writing assessment practices. Specifically, they argue for an approach that favors formative assessment (focused on writing comments that lead to both better writing and better engineering) over summative assessment (which sees writing ability as separate from engineering design). The authors continue by revealing a scoring guide for the formative assessment of engineering reports, and detailing the process by which such a scoring guide may be created. Each criterion in the scoring guide is explained in terms of the rhetorical and engineering principles that it simultaneously addresses.
Swarts, Jason and Lee Odell. Rice University (2001). Articles>Education>Engineering>Technical Writing
#23375
I am asking my program to incorporate more of the liberal arts into the course's title and course description to better appeal to (and serve) students in a liberal arts college. The course will have one or two new sophomore level iterations: as a technical/research writing course in which students complete a semester long service project, researching and writing a final report while focusing on writing, research, and mathematical skills, and/or as a technical writing/document design class where students focus on the document design and writing skills needed to produce items such as a resume, flyers, brochures, posters, and more.
Sehmel, Heather. CPTSC Proceedings (2003). Articles>Education>Writing>Technical Writing
#20639
The Rhetoric of Critical Procedures
One important aspect of technical writing is the production and use of procedures. Though technical writing serves a variety of purposes, teaching, informing, persuading, and even questioning, one of its primary and most common purposes is the 'how-to' function of providing procedures. There is a great deal of information available on writing procedures, the vast majority of it focusing on software documentation and product documentation.
Boelter, Walter H. Orange Journal, The (2003). Articles>Documentation>Rhetoric>Technical Writing
#25397
Rhetorical Context and Process of Professional/Technical Communication
In professional/technical communication, the writer's purpose often relates to helping readers understand, evaluate, or use technology.
Henson, Darold Leigh. Southwest Missouri State University. Articles>Writing>Technical Writing
#21522
In the age of the national information infrastructure, we are inundated with information from various sources. Each day, we come into contact with much more information than we can ever assimilate, and the amount of information that we have access to constantly increases. We generate more and more information daily, and with modern technology, such as Internet, we have immediate access to libraries and databases worldwide.
Jeansonne, Jerold. STC Proceedings (1994). Articles>Writing>Assessment>Technical Writing
#24314
Robert Pirsig’s Message for Documentation Quality
Teachers of technical communication frequently recommend that their students read Robert Pirsig's Zen and the Art of Motorcycle Maintenance (1974) for his views on the complex relationships between technology and human values. As a former technical writer, Pirsig also offers some useful advice about Quality and its relation to the usability of technical documentation. Revisiting Pirsig’s works, including the more recently published Lila (1991), reveals concepts about Quality in documentation that are especially relevant to the usability testing of the documentation for today’s rapidly evolving technologies. This paper examines Pirsig’s views on the some of the characteristics of effective technical communication, and it offers advice to educators and trainers for incorporating Pirsig’s concepts about Quality into their teaching of techniques for the usability testing, and hence quality, of user documentation.
Shirk, Henrietta Nickels and Howard T. Smith. STC Proceedings (1998). Articles>Documentation>Quality>Technical Writing
#20708
Did you ever see the movie RoboCop? Do you remember the prime directives of RoboCop? As a technical writer, you have prime directives as well.
Taylor, Vicki M. Suite101 (2001). Articles>Writing>Technical Writing
#10704
Role of Technical Writers in Developing eLearning
Many companies are starting to use eLearning to train their workers, managers, customers and suppliers. Some of those companies want to use their internal technical writers or communicators to not only write the content, but also to develop the CBT or WBT.
Kurtus, Ron. School for Champions. Articles>Education>Online>Technical Writing
#22113
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.
Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Editing>Collaboration>Technical Writing
#29880
Romancing the Word: From Left Brain to Right Brain
Writing skills can translate to any format. Whether technical documents, media advertising, or fiction, the underlying techniques are the same. A logical approach complements the creativity of putting words on paper. As technical writers, we can expand our skills to storytelling with the same degree of competence we use in our day jobs. The leap from left brain to right brain is not as wide as it seems. This paper briefly discusses one aspiring author's journey, and explores the similarities between technical and fiction writing.
Haire, Susan M. STC Proceedings (2004). Articles>Writing>Technical Writing
#28083
S1000D: A Standard for Technical Documentation
S1000D is a military standard for the creation and delivery of technical documentation. Many companies can benefit from its methodology. Review its history and principal concepts, and learn important information to keep in mind when applying the standard to your work.
Weidenbrueck, Dieter. Intercom (2006). Articles>Documentation>Standards>Technical Writing
#24660
Security Policy and Procedures Documentation
With the nation intensifying its homeland security and industry focusing on computer security, the experienced technical communicator can assist with documenting procedures.
Albing, Bill. KeyContent.org (2004). Articles>Documentation>Policies and Procedures>Technical Writing
#24318
Seeing the World Through Different Specs: Or, How I Came to Love Writing Software Specifications
Much has been said and written about Object-Oriented Programming in the past few years, some of it even worthwhile. While not the panacea on which we've all waited, OOP is, however, changing not only our concept of software design and development, but is subtly re-shaping the way in which we see and know the world. For technical communicators, this epistemological change will radically affect not only the way we craft software specifications, but will permanently re-shape our worldview.
Weathington, Thomas L., Jr. STC Proceedings (1998). Articles>Writing>Specifications>Technical Writing
#29977
Semantic, Structured Authoring
This article looks at the impact of the introduction of semantic markup and structured authoring on the world of technical writers, editors, Help authors and content developers. This article is not specifically about the Semantic Web movement itself, but about the implementation of semantic concepts in the documentation field.
Self, Tony. HyperWrite (2006). Articles>Information Design>Semantic>Technical Writing
#31183
Semi-Definite Rules for the Indefinite Article
Technical writing–perhaps more than any other sort of writing–gets read and used by people from every corner of the Anglophonic world. And people don’t get less sensitive to perceived slights or the appearance of cultural insensitivity because it’s a manual or help page. If anything, they’re more sensitive in such a circumstance.
Forte, Brian. Red Hat Magazine (2007). Articles>Writing>Technical Writing>Grammar
#29044
Service Learning in the Introductory Technical Writing Class: A Perfect Match? 
Teachers at all levels of college instruction use service learning, a popular pedagogical tool since the mid-eighties, to teach students both social consciousness and pragmatic, real-world writing skills. This article explores the concept of service learning as rhetorical action in the field of technical communication in general, and the question of whether service learning is appropriate in beginning level technical writing courses. Using my experience through two years of service learning instruction in community college classes, I respond to the charge that students in lower-division courses may lack the maturity to successfully enact service learning assignments. I also analyze the appropriateness of the community college as a catalyst for community-based writing projects.
Stone, Elisa. Journal of Technical Writing and Communication (2000). Articles>Education>Service Learning>Technical Writing
#29112
Sex Differences in Technical Communication: A Perspective from Social Role Theory
This article interprets technical communication research about sex differences according to social role theory, which argues that sex differences are enculturated through experiences associated with social positions in the family and the workplace. It reevaluates technical communication research about sex differences in communicative and collaborative styles in the classroom and the workplace and about the effects of the double bind that women experience in the workplace. The article concludes with a recommendation that theoretical frameworks explaining sex differences remain flexible and able to account for social change.
Thompson, Isabelle. Journal of Technical Writing and Communication (2004). Articles>Writing>Technical Writing>Gender
#20382
A Short List of Tips for Technical Writing using Microsoft Word
This document provides some pointers on how you can make Microsoft Word work better for you. I assume that you already have a pretty good understanding of the use of Word. This document only covers concepts or techniques that will make the program work better for you. The document was originally developed with Word 97 in mind, but it seems to be relevant for more recent versions as well, though the exact key strokes may differ.
Woodward, Richard T. Texas A and M University. Articles>Writing>Technical Writing>Microsoft Word
#30369
A Simple Recipe to Help Build a Goal-Oriented Training Program for Your Department
Addressing a department's learning requirements is a tough call because of the different levels of complexities and challenges involved. With learning requirements poorly understood and sometimes even out of sync with department goals, a majority of training programs fail to achieve any major business objectives. What you need is the right approach to develop, monitor and standardize a cost-effective, people and result-oriented training program that works magic for you and your department.
Kudesia, Saurabh. STC Management SIG (2007). Articles>Education>Writing>Technical Writing
#27986
Simplified Technical English: STC Should Take the Lead
Proposes that STC become involved in brainstorming ideas about Simplified Technical English, thus leading the way for clear, correct documentation.
Lester, Larry. Intercom (2006). Articles>Writing>Technical Writing>Minimalism
#20463
Single Sourcing in Technical Communication
No term has caused such a sensation in recent years among technical writers and illustrators as 'Single Sourcing.' The reasons: Enormous amounts of text and image material builds up in documentation and illustration companies. It is not uncommon for individual documents to contain several thousands of pages. If this is translated into several languages, then the administration needs are greater for both texts and graphics (graphics can contain text which must also be translated).
Fibinger, Iris. SVG Open (2002). Articles>Content Management>Single Sourcing>Technical Writing
#26726
Six Reasons You Don't Need a Technical Writer (and Why They're Dead Wrong!)
Hiring the right freelancer to do the job correctly the first time around could save you hundreds or thousands in help desk calls, service calls, document revision, and distribution. Here's why.
Zuccardy, Ann. Ezine Articles (2005). Articles>Project Management>Writing>Technical Writing
#24657
Software Development Kit (SDK) Documents in 10 Simple Steps
Here are the ten simple steps to successful software development kit (SDK) documentation.
Buck, Catherine. KeyContent.org (2004). Articles>Documentation>SDK>Technical Writing
#27584
Software documentation or source code documentation is written text that accompanies computer software. It either explains how it operates or how to use it. In fact, the term software documentation means different things to different people. This article describes the term as used by the largest groups of users.
