Ten More Errors in Technical Writing

So, well, here are 10 more errors. This time we will focus on grammar and punctuation. Most of these are simplistic and obvious. But then they are too common. As usual, I have slipped in some content for the advanced writers too. (This article is a follow-up to 'One Hundred Simple Tech Writing Errors .)

Kamath, Gurudutt R. IT People (2003). Articles>Editing>Grammar>Technical Writing

The Art Of Editing: User's Guides Versus Technical Documents  

While contemplating topic areas for a presentation at this year's conference, our biggest challenge was the fact that not all technical editors edit the same type of documents. Presentations at STC conferences are heavily concentrated toward user documentation and software instructional manuals. With that as our prime focus, we identified six common elements that we both consider as we edit a document. We then compared our methods of approaching these elements. One of us edits primarily user's guides and procedural manuals; the other edits scientific and technical documents.

Cluff, Susan C. and Sandra R. Marks. STC Proceedings (1994). Articles>Documentation>Editing>Technical Editing

Working Electronically

Editors need to know some basic techniques for dealing with files if they are going to be editing them electronically. These techniques apply to files in any format, but exactly what you do depends on which word-processor, desktop publishing program, help authoring system, or other software you are using.

Hollis Weber, Jean. Technical Editors Eyrie (2001). Articles>Editing>Technical Editing>Online

Developing Indexes

As a technical writer, you'll typically have to create indexes for the print books and for online helps you develop. The type of index we mean here is the classic back-of-book index that shows page numbers on which topics and subtopics occur within the book. An online index is much the same except that you supply hypertext links rather than page numbers.

McMurrey, David A. Illuminati Online (2004). Articles>Editing>Indexing>Technical Writing

Transline tecNews

Kontinuierlich Nachrichten, Hintergrundberichte und Interviews rund um die technische Dokumentation und Redaktion, sowie die technische Übersetzung. In der Nachfolge der doculine news.

Transline. (German) Resources>Documentation>Technical Editing>Blogs