A directory of resources inthe field of technical communication (and technical writing).

Presentations>Writing>Documentation

5 found.

About this Site | Advanced Search | Localization | Site Maps
 

 

1.
#13457

Concrete Methods that Promote Active Learning in Software Manuals  (link broken)   (PDF)

To learn software, passive users prefer to have concepts and procedures clearly spelled out for them, while active learners prefer experimenting with the program. When designing a manual, writers should keep both types of users in mind. Writers at WordPerfect are currently experimenting with minimalist design models that encourage active learning. One such model is an “On Your Own” section which guides users through creating a document. Another model is a visually oriented “Applications” section which provides tips on how to create a document.

Bringhurst, Robert G. STC Proceedings (1993). Presentations>Writing>Documentation

2.
#14503

Producing Site-Specific Training Materials: How Technical Communicators Can Increase Job Security   (PDF)

According to the SCANS report, '80 percent of the workers on whom American employers will depend as we enter the 21st century are already on the job.' Onsite employee training and retraining must become a major focus for American companies. Technical communicators can develop site-specific training materials for their employers, but they will need to 'speak another language' in order to communicate the potential savings and benefits to management. Technical communicators who produce site-specific training materials can increase their job security by increasing their employer's ability to compete.

Wietelman, Sherry S. STC Proceedings (1994). Presentations>Documentation>Writing

3.
#18216

The Sequential Order of Instructions: Impact on Text Quality   (PDF)

In written instructions, the sequential order of procedural steps is crucial for effective and efficient performance. In this paper we demonstrate several “rules” for optimizing instructions in this respect: First things first: put instructions in an order that prevents users from neglecting important steps. Minimize cognitive load: put instructions in an order that allows readers to forget what they read. Save time and effort: put instructions in an order that “on average” requires as little time as possible of the readers.

Steehouder, Michael F. and Carel J.M. Jansen. STC Proceedings (1996). Presentations>Documentation>Writing

4.
#21696

UNIX Man Pages   (PowerPoint)

Experienced programmers find the man pages very useful but a naive user often finds them overwhelming.

Gururaj, B.S. STC India (2003). Presentations>Documentation>Technical Writing>UNIX

5.
#32683

Becoming an API Writer: How I Learned to Stop Worrying and Love Developers  (link broken)

If you know API writing, there is greater demand for your skills, that is, there are more jobs to which you can apply. At the same time, there is a shortage of API writers. API writers tend to work more closely with development, instead of through product management or product definition or through specs. You are closer to those who design the product, privy to design decisions -- closer to the action.

Wroblewski, Daniel. STC Proceedings (2008). Presentations>Documentation>Writing>Technical Writing

There are 13 readers currently online: 0 registered users and 13 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon