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.

Weber, Jean Hollis. STC Proceedings (1997). Design>Information Design>EPSS

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.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Project Management>EPSS

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.

Hollis Weber, Jean. Technical Editors Eyrie (1999). Articles>Documentation>Online>Help

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.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Editing>Collaboration>Technical 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.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Writing>Grammar

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.

Weber, Jean Hollis. STC Proceedings (1996). Presentations>Management>Collaboration>Online

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.

Weber, Jean Hollis. Technical Editors Eyrie (2003). Books>Writing>Word Processing>OpenOffice

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.

Weber, Jean Hollis. Technical Editors Eyrie. Journals>Editing>Regional>Australia

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.

Weber, Jean Hollis. O'Reilly and Associates (2004). Articles>Word Processing>Software>OpenOffice

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.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Writing>Style Guides

"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.

Hollis Weber, Jean. Technical Editors Eyrie (2000). Articles>User Centered Design>Methods

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.

Hollis Weber, Jean. Technical Editors Eyrie (2002). Articles>Writing>Style Guides>Grammar

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.

Hollis Weber, Jean. Technical Editors Eyrie (1999). Articles>Writing>Workflow

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

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.

Weber, Jean Hollis. TECHWR-L (2002). Articles>Writing>Collaboration

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.

Weber, Jean Hollis. O'Reilly and Associates (2004). Articles>Word Processing>Software>OpenOffice