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

Articles>Writing>Online>Technical Writing

4 found.

About this Site | Advanced Search | Localization | Site Maps

 

1.
#31991

The Hidden Power of the Online Manual

Writing software manuals is boring, isn't it? We often think, "My software is easy to use. The user interface is intuitive. Why should I waste so much time writing documentation which nobody will read anyway?" Sometimes it's true. I've never read the WinZip or Internet Explorer manuals. Everything seems clear enough without further explanation. Nevertheless, even if your manual isn't being helpful to your software users, it may be helpful to you. Publish your manual online and turn its hidden power into a real benefit for your business.

Crane, Dennis. Dr. Explain (2006). Articles>Documentation>Online>Technical Writing

2.
#13052

Prototypes in Technical Writing: What are They?

A prototype is, generally speaking, a preliminary model of a larger, more detailed object. In technical writing, a prototype might be a full table of contents (with summaries for each major section) and one or two complete chapters. If conducting a survey is an important part of your project, your prototype might be a complete survey of a small number of subjects, designed to iron out the kinks in the questions you want to ask. A good prototype will help you identify flaws (such as incomplete research or mistaken assumptions) before you have multiplied their harmful effects by investing additional effort in them. A sculptor makes a scale model in clay -- a prototype -- before chiseling away at a full-sized chunk of marble. It it much easier to fix major mistakes in clay than it is to throw away a ruined chunk of marble and start over again.

Jerz, Dennis G. University of Wisconsin-Eau Claire (2000). Articles>Writing>Online>Technical Writing

3.
#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

4.
#13695

Technical Writing in a Technological Age: Changes in the Classroom and the Workplace  (link broken)

Over the past decade, new media and computer technologies have permeated both the technical writing classroom and the technical writing workplace. Documents written for, and used in, these two contexts no longer include just verbal text messages and simple line art printed on standard, 20 pound white paper, as they often did in the 1970s and early 1980s. Technical writing documents today appear not just in print but in electronic form, and in electronic form these documents include multiple media such as high-resolution graphics, audio and video clips, animation sequences, and visual effects. Couple this expanded electronic form of technical writing with Internet protocols that allow for the global exchange of information, and it becomes clear that distinct challenges and opportunities exist for the field of technical writing in a technological age. What is the nature of these challenges and opportunities in the classroom and the workplace? And, what is the relationship between new media, computer technologies, and the changes currently evident in these two contexts?

Selber, Stuart A. Addison Wesley Longman (1997). Articles>Education>Online>Technical Writing

There are 14 readers currently online: 1 registered user and 13 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon