Hollis Weber, Jean

Getting the Most from OpenOffice.org Writer Fields

Fields are extremely useful features of Writer. This article describes how to use fields to solve common business and technical writing problems.

OpenOffice.org and Me: An Introduction

When I first tried OOo, it was at around version 1.0.0 or 1.0.1. The help files were pathetic in those days; I described them at the time as 'badly written, badly organized, badly indexed, and frequently wrong.' To be fair, the help has improved a great deal since then, though the indexing still needs a lot of improvement.

Writing, Editing, and Reviewing Documents

OpenOffice.org Writer provides many ways to write, edit, review, and comment on documents. This chapter covers some of those techniques, plus some other tips.

Technical Writing Using OpenOffice.org Writer

If you're in the business of writing technical documents and you've been using Word in particular, you could benefit by switching to OpenOffice.org Writer. OpenOffice.org Writer is a strong competitor to Word for both drafts and final layout (desktop publishing) of many technical documents because it combines some of the best features of Word and FrameMaker. Indeed, Writer does several things better or easier than each of them.

Planning an Electronic Performance Support System Project

Electronic performance support systems are programs that directly support a worker's ability to perform tasks. Such systems go beyond passive task-oriented online help. To be effective, EPS systems should be closely interlocked with the supported product's user interface and its online help. This paper outlines some of the planning considerations and steps involved in an EPSS project, and some of the problems and complications that arose during a specific project.

Editing for an International Audience

Here are some things to consider when editing for an international audience.

Electronically Indicating Approvals or Rejections of Editorial Changes

This technique (involving two macros) works in Word97, but not in Word6 or 7/95. The requirement is to indicate (for audit purposes) whether an editorial change was accepted or rejected by the author or other authority.

Gender-Neutral Technical Writing

In recurring discussions on the TECHWR-L list, many technical writers argue that they write in 'correct English' and are not going to change their style just to suit the political-correctness police. 'I won't use 'they' as a singular pronoun because it's not grammatically correct' and 'Using contrived phrases such as 's/he' is just too awkward' are arguments I've heard frequently in the debate. But using 'incorrect English' or contrived phrases is neither the goal nor the outcome of gender-neutral writing.

Stressing What is Important in a Sentence

In addition to expunging the usual collection of wordy phrases from documents, editors commonly attempt to tighten up writing to make it more direct, clear, and concise. For example, when editing business and technical material, I frequently change sentences containing 'it is,' 'there is,' and 'there are.' Writers often ask me 'what was wrong with that sentence?' I reply that although the sentence wasn't wrong grammatically, such phrases distract the reader from the important part of the message.

Terminology and Spelling for Web-Related Concepts

Generally speaking, 'Web' as a short form of 'World Wide Web' is capitalized, with one exception (webmaster). However, your company style may prefer the lower-case version.

Use of Hyphens

This page collects a series of notes from readers of my newsletter, and my responses to those notes, arising from an article in issue 60, 13 May 2002. I thank those who took the time to write and explain why some hyphen usage is considered to be correct or incorrect.

Alternatives to the Paragraph

'It's all in the manual.' How many times have you heard that - or said it in frustration? After all, when you are the person who wrote the manual, you know that all the answers are there. But time and again readers can't find what they need to know, or don't understand the material. Before you blame the reader, look again at how you've presented the material.

Audience and Document Analysis

Before you begin editing a document, try to find out as much as you can about the audience for the document and purpose of the document.

Choosing and Using Help Topics

This paper describes some common types of help topic and when to use each. Different applications require different mixes of help topics. Choose the topic types that are appropriate for the application you are documenting.

Deciding What Needs to be Done

Before you begin editing a document, you need to analyse it and plan what needs to be done. The exception is when your job is strictly limited (by your supervisor or the client) to correcting only the glaring errors of spelling, punctuation and grammar (a 'light edit'). There is no point to attempting a more substantive edit if doing so will only get you into trouble (or if the client won't pay you for the time you spend).

Editing Reports and Proposals

Businesses, non-profit organizations, government departments, and other groups produce a lot of proposals and reports. This article summarizes some features of reports and proposals that are not the same as books, news items, manuals, magazine articles, memos and many other documents.

Editing Single-Sourced Projects

This article does not address the (important) questions of when a single-sourcing methodology is a good solution to an information delivery problem ('good' here meaning saving time and money while maintaining or improving the quality of the resulting deliverables). Instead, I'm looking only at the editor's involvement in the project.

Editing Tables of Data

Tables should allow readers to easily and accurately: see what subject matter and variables are being described; find out absolute values; observe relationships between variables. When you edit a table, it is useful to assess just how well it achieves these ends. Readers will feel confident with your table if they can quickly navigate around and absorb the data.

An Example of Substantive Editing

Some years ago I edited a quarterly magazine for the users of a large Australian computing network. This example (from 1985) is fairly typical of the technical articles I received from department managers. I include here the unedited text and my revised version.

Hints for Developing a Table of Contents

Planning a project before beginning the detailed work is one of the vital steps to success in technical communication. Developing a table of contents is one of the steps in the planning process of a document.

Planning an Electronic Performance Support System Project

Electronic performance support systems are software programs that directly support a worker's ability to perform tasks. Such systems go beyond passive task-oriented online help. To be effective, EPS systems should be closely interlocked with the supported product's user interface and its online help. This paper outlines some of the planning considerations and steps involved in an EPSS project, and some of the problems and complications that arose during a specific project.

Planning an Online Help Project

This paper outlines some general principles you need to consider when planning an online help project and creating WinHelp files.

The Role of the Editor in the Technical Writing Team

Editing today covers far more than printed materials. In this discussion, I am assuming a technical editor may be required to deal with: printed materials (for example, books, pamphlets, quick reference cards); electronic (for example, online documentation, online help, web pages); video scripts; computer-based training materials. I am also assuming that the audience for the material being edited is not comprised of other technical people; or if it is, the editor is not the person responsible for ensuring the technical accuracy of the material.

"Use Cases" and "User Scenarios" Explained

This file contains the responses I received to a message I sent on January 21, 2000 to the TECHWR-L and WINHLP-L discussion lists. It was posted on the Techwhirl website for awhile but was removed during a reorganisation of the site. Other people's comments are included with their permission.

Using Style Sheets

Style sheets supplement the style manual (if there is one). You might also use one to summarise vital information for your own reference or to give to an editor. Record on a style sheet any decisions made for a particular product or publication.

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.

Taming OpenOffice.org Writer 1.1: Tips and Tricks for Academic, Technical, and Business Writers

This book is for intermediate and advanced users of OpenOffice.org Writer. You may not have used this program before, but you have used another word processor (such as Microsoft Word or Corel WordPerfect) and you are familiar with the basics of word processing. Typical users include academic writers, technical writers, and other business and professional writers—anyone who produces books, research papers, proposals, or other documents requiring the use of more than the basic features. For example, you need to use styles instead of direct formatting of headings and other paragraphs, and you need to include chapter information in the footers of pages, or you want to use master documents to control a book containing many chapters, perhaps written by different people.

Escape From the Grammar Trap

Too many editors focus on the details and don't pay enough attention to the bigger picture. Editors can--and should--add even more value through substantive, technical, and usability editing. Copyediting is important, but the details are only part of what an editor can and should be reviewing. After all, a document can be correctly spelled and punctuated, grammatically correct, use only approved terminology, and follow the style guide perfectly--and still not serve the audience's needs. This article covers some reasons why editors focus on details and not the bigger picture; describes how much attention technical communicators should pay to formal rules of grammar, punctuation, and usage; and describes how we can distinguish between essential and nonessential rules of grammar, punctuation, and usage.

Gender-Neutral Technical Writing

Gender-neutral writing uses language that does not stereotype either sex nor appear to be referring to only one sex when that is not the writer's intention. In this article, you'll see why gender-neutral writing is important for technical writers to use, what gender-neutral writing is not, and how you can use gender-neutral writing in the documents you develop.

Taming a Telecommuting Team

“Telecommuting” includes situations where members of a group (department, team, other) are working in different locations, communicating with each other and with clients by phone, fax, and e-mail. The team may be dispersed through an urban area, nationally, or internationally. Telecommuting has advantages and disadvantages over the traditional centralized working group and presents new challenges to management and staff As a team leader of telecommuting technical writers on software development projects, I have dealt with many of these Issues. In this discussion I cover some of the advantages and disadvantages and some principles and rules of successful telecommuting teams.

Developing a Departmental Style Guide

As a technical writer, you may be asked to develop a style guide for the hardcopy and online documents you produce. Sounds easy enough. After all, commercial style guides and, potentially, examples shared by your colleagues should provide enough information to get you started. In researching your task, though, you may find a variety of definitions and explanations of what a style guide is and why companies use them. What's more, you many find that style guides don't seem to have consistencies among them that can help guide you in developing one.

Example Style Guide

This document accompanies the TECHWR-L article 'Developing a Style Guide,' and includes a sample outline of a style guide. Some of the sections include some detailed sample text; others do not. Please note that the examples shown here are not necessarily the 'correct' choices, or the 'preferred' choices, or the 'best' choices; they are simply examples of things to include. Your project may require additional items, especially if your writing will be used on a Web site.

Grammar, Punctuation, Spelling

The Web abounds with sites teaching grammar, punctuation, and spelling. Not surprisingly, most of these sites are provided by educational institutions, teachers, or business-writing consultants, presumably to make up for the lack of grammar teaching in so many school systems for the past several decades. Some are tutorials (masquerading as style guides) for technical communicators. Here are a few sites that I have found useful or that other people have recommended to me.

Working with a Technical Editor

If you have never worked with an editor before, you may be wondering what to expect, and what the editor will expect from you. If you have worked with an editor before, you probably have some expectations about the relationship. Whether your past experiences were good or bad, you may be quite surprised to discover that the new editor's expectations are rather different from yours. This article looks at some aspects of the writer-editor relationship and what each of you can do to get the best results out of working together.

Gender-Neutral Technical Writing

Choosing and Using a Technical Writer

Offers advice for anyone looking to hire a technical writer on choosing a writer and using a writer.

Ethics in Scientific and Technical Communication

Discusses many ethical issues including: taking personal responsibility for one's actions, Behaviour toward colleagues, subordinates and others,Dealing with experimental subjects, interviewees, etc, Telling the 'truth', and choosing between advocacy and objectivity.

Editing for Gender Neutrality

How to be politically correct without mangling the English language. The goal is that the reader should not notice the writing.

Editing Glossaries

Traps for the unwary are common in technical writing. In my 20 years of editing, I've seen a lot of things that have slipped by writers and reviewers.

Editing Online Materials

Editing anything that is intended to be read on a computer rather than (or in addition to) being read on a paper copy.

The Technical Editors' Eyrie

The newsletter is intended for editors who are, or need to be, working electronically. Much of the material will be relevant to electronic editors in any field. Some of the material will be most relevant to editors in technical fields such as computing and engineering.