Category: Proceedings

Articles published in the STC Technical Communication Summit Proceedings related to policies and procedures.

Writing Procedures Like a Pro — The “How To” of “How To’s”

Proceedings-1999; By Rebeca J. Edgerton and Jill Nicholson; Summary by Maria Christophel (2006) This article is a brief summary of the session to be presented at the STC Conference. It is an invitation to attend the workshop for “Writing Procedures Like a Pro.” It outlines the topics of the workshop, its benefits, and advantages.

Procedures – The Sacred Cow Blocking the Road

Proceedings-1998; By Michael Hughes and Loren Burke; Summary by Maria Christophel (2006) This article introduces characteristics of procedures that produce a mismatch when compared to characteristics of users’ needs and expectations. It explains the principles of user interaction with written documentation and elaborates in detail on the emerging non-relevance of step-by-step- procedures as written today.

Information Gathering for Policies and Procedures

Proceedings-1996; By Christine Dodwell; Summary by Maria Christophel (2006) This article provides a view of the various methods for collecting, using, and maintaining policies and procedures information. It defines internal sources, external sources, and publications as places to begin research. It explains the steps for collecting the information as interviewing, researching, outlining, detailing, and following up. It presents the need for maintaining files of the research and documentation process.

Writing Clear Policies and Procedures with Playscript

Proceedings-1999-J. Richard Flemming CMC; Summary by Maria Christophel (2006) This article presents Playscript as a documentation technique, and addresses the most important benefits of using this technique for writing policies and procedures. It defines “Performance Orientation,” and details a method for using action writing. It establishes the need for structured writing as a complementing format to the Playscript technique to achieve clarity; and provides examples for using structured writing.

The Team Approach to Writing Policies and Procedures

Proceedings-1996; By Diane L. Whitmer; Summary by Maria Christophel (2006) This article provides a brief insight of the benefits inherent in using the team approach for writing policies and procedures. The article provides a method for structuring the documentation teams, for planning the writing, and for developing the documentation. The article describes team consensus, sense of ownership, stronger writing skills, and sense of hard-earned accomplishment as benefits of using the team approach.

Flowcharting Processes and Procedures

Proceedings-1994; Raymond E. Urgo; Summary by Maria Christophel (2006) This article is a brief summary of the discussion presented at the STC Conference. It introduces Flowcharting as a tool, which technical writers may use for communicating processes and procedures. This article notes the difference between a process and a procedure, and it defines the appropriateness of flowcharting for either. It mentions interrelation of processes, the source of flowcharting symbols, and the techniques of flowcharting design.

Flowcharting Performance-Based Processes and Procedures

Proceedings-1995; Raymond E. Urgo; Summary by Maria Christophel (2006) This article provides a brief insight into flowcharting as a tool for documenting processes and procedures. It defines flowcharting and describes its origin, format, and style. It briefly discusses tools, training, and trends.

Dynamic Content Management

Proceedings-2002-By Ann Rockley; Summary by Maria Christophel (2006) This article defines dynamic content and provides examples of its use by companies of diverse operations and by E-commerce. It lists and explains the requirements for developing dynamic content, and provides a diagram that defines the process of dynamic content. It discusses the delivery of dynamic content documentation and explains the importance of dynamic content engines to retrieve the stored information. It notes this new writing method to be an opportunity for technical communicators, information designer/architect.

Developing Internal Procedures Online – The HowWe Manuals Project at Suncorp

Proceedings-1996; By Dean Bell and Helen Smith; Summary by Maria Christophel (2006) This article provides a brief outline of the topics that were covered in the session presented at the SCT Conference. The purpose of the session was to relate activities performed during the various phases of developing internal procedures for online delivery at Suncorp.

Writing Processes and Procedures Using Audience Analysis and the ISO 9000 Document Hierarchy

Proceedings-2000: By Tricia Cunat and Amary Craig; Summary by Maria Christophel (2006) This article describes the method for writing processes and procedures using as the base a detailed analysis of the audience and the ISO 9000 definition of process vs. procedure. It provides a detailed definition and a comparison between processes and procedures, and provides examples of when using either or both is appropriate. It defines audiences and provides a model matrix for identifying potential audiences in the development of a user manual. In addition, it presents types of formats for delivering processes and procedures to the audience.