Do Technical Writers Need a Help Applications Course?  

Weber State University is in the process of developing a major in Professional & Technical Writing (PTW). Currently, students enroll as English majors with an Emphasis in PTW, which consists of four courses in PTW that students take in addition to other English courses. The minor consists of the same PTW courses plus two interdisciplinary classes, which are determined in consultation with an advisor. The problem is that students who wish to do PTW must take the same number of literature classes as other English majors. Often they do not receive instruction in document design, other than a cursory treatment in the service course. A full major would better prepare students to enter the job market without losing connections to critical theory and humanistic approaches to texts-connections they receive in English Department courses.

McShane, Becky Jo. CPTSC Proceedings (2003). Articles>Education>Documentation>Help

Documentation Methods for AACSB Learning Assurances  

In 2003, the Association to Advance Collegiate Schools of Business (AACSB) redefined their accreditation and reaffirmation standards to move from a traditional outcome-based system to a systematic process-based review. Documentation is required to assure student learning in several core areas, including communication. This paper outlines the data collection procedures and documentation methods used to document one university’s business communication learning assurances.

Gueldenzoph, Lisa E. Association for Business Communication (2008). Articles>Documentation>Education>Business Communication

Extensible Markup Language: How Might It Alter the Software Documentation Process and the Role of the Technical Communicator?    

This article describes the influence that Extensible Markup Language (XML) will have on the software documentation process and subsequently on the curricula of advanced undergraduate and master's programs in technical communication. XML, an evolving set of standards for storing and displaying information, uses nine components that make up the XML development process. Grouped into content, formatting, and language specifications, these components enhance organizations' ability to manage information more efficiently and accurately. As the XML development process is adopted, the software documentation process will evolve from a self-contained procedure into a more flexible, interactive process in which software documenters must work closely with a wide range of specialists. The changes that XML will have on the software documentation process will likewise have implications for programs in technical communication in the need to address new kinds of job descriptions, skill sets, and career paths of future technical communicators. The article recommends adaptations to existing courses, as well as new elective and required courses.

Battalio, John T. Journal of Technical Writing and Communication (2002). Articles>Documentation>Education>XML

Insert Clever Title Here: Creating and Using Multi-Purpose Information Blocks for Documentation and Training  

Our technical writers and course developers share several objectives. We must provide task oriented information to our customers, we create information for a variety of products, and we follow a similar information development cycle. We also spend a great deal of time re-creating the same information over and over. To make our efforts more efficient, and to creole better information for our customers, we’ve changed the way we think of information, how we initially create the information, and how we store and retrieve the information. This paper describes the methods we chose to accomplish these goals, the tools we use, and our successes, failures and frustrations.

Brockett, Susan H., James Cox, Lelanie S. Hellmer and Susan Katz. STC Proceedings (1995). Articles>Documentation>Education

Instruction-Writing Exercises (for High School)

These guidelines and 14 scaffolded exercises respond to the unmet need for a psychologically solid, work-relevant way to learn technical writing by students who are NOT facile writers already.

Girill, T.R. STC East Bay (2001). Articles>Education>Instructional Design>Documentation

Intentional Learning in an Intentional World: Audience Analysis and Instructional System Design for Successful Learning and Performance    

How do we support successful, lifelong learners and performers and help them competently respond to rapidly changing opportunities in the 21st century. The answer to this question lies in how well we understand audiences differentiated by key learning differences and consider how these differentiations influence winning learning and performance. Historically, cognitive-rich explanations have tended to underplay the dominant impact of affective and conative factors on thinking and learning. Recently, these dimensions have gained considerable importance as contemporary multidisciplinary research has begun to demonstrate how intentions and emotions can influence, guide, and, at times, override our thinking and other cognitive processes. More importantly, research suggests that intentions and emotions are a dominant, powerful influence on learner success.

Martinez, Margaret. Journal of Computer Documentation (2000). Articles>Documentation>Instructional Design>Education

Let the User Write the Documentation  

Teaching non-writers how to write can be challenging, especially when they are adults using new software to do their jobs. But who knows best how to write about their jobs than the end users. Through field experiences and case studies, this paper describes methods and approaches for eflectively including the end user in the documentation process, as well as educating experienced writers who are new to the system.

Doyle, Diane J. and Janet M. Samuelson. STC Proceedings (1997). Articles>Documentation>Education>Writing

Notes Toward a Socially Informed Pedagogy for Computer Documentation    

This article extends Johnson-Eilola's main argument and then, using a thought experiment, examines an extended example of its implications. The experiment follows a student who learns how to produce technical communication artifacts following the philosophy that informs most technical communication classes and that leads to production of the functional but not conceptual systems Johnson-Eilola critiques. The article concludes by recommending changes in overall curricula and in individual courses that would better educate communicators to account for the social implications of their work

Selber, Stuart A. Journal of Computer Documentation (2002). Articles>Education>Documentation

Online Documentation in Reference-Based Instruction: A Practical Model for Integrating Help Systems Into Product Training    

Companies can improve customer satisfaction while reducing training time and product support costs by integrating online documentation with product training. Online documentation can be designed to be not only the reference at the point of use but also the primary instructional medium used during training. This use of the online documentation during training increases user acceptance of it and helps develop the required skills for its use. This expanded role for online documentation provides new opportunities for technical communicators to add value to their roles within their companies. This article defines reference-based instruction and outlines its benefits. It describes how reference-based instruction can be incorporated into an instructional system design (ISD) and provides specific examples of learning objectives and student exercises. It lists guidelines for how to structure usability tests for Help systems, and finally, it advises how technical communicators can use reference-based instruction to ex

Hughes, Michael A. Technical Communication Online (1997). Articles>Documentation>Instructional Design>Education

Proposed Multimedia Courseware Documentation Design  

With the growth of multimedia, design techniques to manage the contents and data structures for the media are becoming required We call this courseware in distinction from hardware or software, and we produce a production model by developing a uique technique not in imitation of the conventional ones using the following three points, layout, framework and linkage management.

Hayashizaki, Akira. STC Proceedings (1993). Articles>Education>Multimedia>Documentation

Teaching Documentation Writing: What Else Students--and Instructors--Should Know    

Discusses knowledge, problem-solving strategies, and desktop publishing skills students need to learn about documentation writing. Describes a course that provides these skills. Also applies to in-house training programs.

Boiarsky, Carolyn and Michael Dobberstein. Technical Communication Online (2003). Articles>Education>Documentation>Technical Writing