Applying Web 2.0 Technologies to Technical Documentation

This article is based on my presentation at the Institute of Scientific and Technical Communicators' annual conference in October, 2006. Every now and then, there is a change in the value of what technical authors deliver. These are moments when organisations pay attention to technical documentation. This is because they recognise that these changes mean they can create something that will be of real value to the business and to their customers. In recent years, there have been three "waves of interestingness". The first wave was the introduction of Windows Help (WinHelp). The second major wave was the introduction of the Internet and intranets. This was a time when organisations looked at how they could transfer large amounts of information from paper to online. They were faced with issues such as how users could access and understand all this information easily - issues that technical communicators deal with on a day-to-day basis. I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

Pratt, Ellis. Cherryleaf (2006). Articles>Web Design>Documentation>Technical Writing

Conciseness is Key to Good Technical Documentation

One of the most important and difficult parts of technical documentation concerns writing in a concise manner. Technical writing is different than writing fiction or magazine articles, where a mood may be set or--in some cases--where space must be filled. (People seldom buy thin books.)

Kurtus, Ron. School for Champions (2005). Articles>Document Design>Technical Writing>Minimalism

Creating User-Friendly Documentation

We often hear that users do not read documents. To lure readers into reading our documents, we must make documents user-friendly.

Bhatia, Neeraj. Indus (2002). Articles>Documentation>User Centered Design>Technical Writing

Creating User-Friendly Links

Google returns well over 15 million search results to the technical question of how to code hyperlinks in HTML. However, a question on how link texts should be formulated, so that the reader can understand them clearly, fetches only a handful of usable tips. Even most style guides and authoring guidelines are reticent on this topic. In this article you will find tips on this rarely dealt with, though important subject for Technical Communicators.

Achtelig, Marc. indoition engineering (2005). Articles>Writing>Document Design>Hypertext

Equations

Equations must have a number in parentheses at the right of the page. Must be numbered in the order they appear. Must be able to be read as part of the text.

Young, V.L. and K.J. Sampson. Ohio University (2004). Articles>Document Design>Technical Writing>Mathematics

Heading Frequency and Comprehension: Studies of Print Versus Online Media  

This paper describes a study that examined the effect of heading frequency on comprehension and perceptions of information presented in print versus online text. Results indicated that heading frequency did not differentially affect the comprehension of readers of print text while it did differentially affect the comprehension of readers of online texts who had considerably lower comprehension scores with text that had high frequency versus medium frequency headings.

Spyridakis, Jan H., Laura D. Schultz and Alexandra L. Bartell. STC Proceedings (2005). Articles>Document Design>Writing>Usability

How to Write a Newsletter

Newsletters are one of the least expensive -- and most effective -- public relations tools that exist for drawing attention to a business or Web site. By sending out a quality newsletter on a regular basis, you can keep clients, potential clients, the media, and other important sources updated about your business. Frequency of mailing builds familiarity, and familiarity inspires return visits. Plus, the effort of creating a newsletter itself speaks volumes about your commitment to the subject. It also positions you as an expert and a valuable resource.

Writing That Sells. Articles>Document Design>Journalism>Writing

IBM User-Centered Design for the Documentation Designer  

The user-centered design of documentation is an aspect of product design that has often been under-emphasized. Difficulties inherent in documentation design include obtaining user, feedback to high-level design objectives; extracting user. feedback specific to a product’s documentation. rather than to the product as a whole; and managing the various resource constraints inherent in product development. IBM User-Centered Design offers a solution to these difficulties by employing a set of user feedback methodologies from which the documentation designer, a member of a multidisciplinary design team, extracts pertinent data to set design objectives and follow through to low-level designs.

Righi, Carol and Lynn VanDyke. STC Proceedings (1996). Articles>User Centered Design>Documentation>Technical Writing

Is Your Website Poised to Deal With Its Growth?  

Every webmaster nourishes the dream that his or her website will make it the big way. This is very much human because people carry out any task in ardent hope. What is more human out here is that earthy fellows like us base our aspirations more on speculation rather than specific set of steps undertaken to bring the dream a bit closer to reality. And this is not all, particularly in case of growth of a site which brings newer problems in the wake of its growth. It cannot be disputed that you can probably get some good web hosting on economy price. But if you expect top of the line service on this price, acknowedge gracefully that your are just asking for the moon. Probably you are not catching up with wisdom that business needs decisive investments.

Azam, Rahbre. Amateur Writerz (2008). Articles>Documentation>Web Design>Technical Writing

Producing Brochures in the Technical Writing Classroom  

Producing brochures for real clients teaches college-level technical writing students about constraints of cost, time, and the availability of materials. Brochure writing also provides opportunities for learning more about editing, collaborative work, document design, and the problems which may occur during the production of real documents. Brochures of good quality can be produced by a class in approximately three weeks, or nine classroom hours. Grading brochures is expedited through the use of a simple heuristic.

Ryan, Charlton. STC Proceedings (1993). Articles>Education>Document Design>Technical Writing

Technical Writing in Everyday Life: One User's Experience

The experience of setting up a new home theater system also sharply reminded me of what it is like to look at something as a new user: staring at a bunch of knobs and holes for the first time, holding a tassel of wire in one hand and a manual in the other, and really just wanting the darn piece of ?%^%! to do what it's supposed to do.

Vedrody, Sarah. MetroVoice (2002). Articles>Documentation>User Centered Design>Technical Writing