Minutes from Our Business Meeting at the Conference

Virginia Janzig

The business meeting of the STC Technical Editing Special Interest Group (TE SIG) was called to order by Pat Moell on 3 June 2008, at 7:30 a.m., in the Philadelphia Marriott Downtown Hotel.
Pat recognized members of the board who were present. She also noted that the Distinguished Service Award was going to be presented to Diane Feldman at the 55th Annual STC Technical Communication Summit recognition banquet that evening.

Pat identified SIG accomplishments and areas of direction for the SIG:
• Bylaws, budget, and strategy
• Job listing aids
• Continue to hold annual elections (first election held October 2007)
• Provide 2 scholarships yearly
• Continue quarterly membership meetings
• Improve Web site

Pat asked each attendee to introduce themselves and identify what the TE SIG is doing that is worthwhile and identify things that might be offered to the membership.

SIG suggestions
• Continue quarterly meeting topics
• Consider repeating popular topics
• Discussion list is useful
• Opportunity to meet people
• Sense of community, validation of work and career
• Love of language (St. Bernadette’s Barking Dog)
• Change time of meeting once a year to accommodate other time zones
• Job bank, specific editing opportunities, possible link to LinkedIn?

Style guides and other resources
• Style manual in a wiki
• Consolidating style guides
• Need strong knowledgebase
• List of style manuals
• Open source style guide. Sun is driving this. SIG needs to be heavily involved.
• Automate process for updating style guides.
• Common ground for international style guide: international companies using one language with writers and editors from many languages and cultures.
• Terminology – AP, Chicago Manual of Style, IEEE, software, writing (content management)

Editing – types, different ways to do it, skills
• Types of editing: journalism, technical, peer (peer review), small groups, international groups, group editing, content versus context
• Differentiate writing and editing
• Writer-to-editor ratios – how to handle, what to edit
• Expanding editing skills to provide value, protect job
• Editors who do other things – how to juggle different jobs
• Collaborating with writers, subject matter experts, building relationships, lessons learned
• Editing engineers and other highly technical subject matter experts – approaches

Management stuff
• Getting STC into large companies (possible?)
• Getting STC out to more lone writers
• Metrics for management, ROI, prove the value of editing to management.

The meeting was adjourned at 8:35am.

 

Book Review of “Effective Onscreen Editing” by Geoff Hart

Virginia Janzig

Geoff Hart’s book, Effective Onscreen Editing (Diaskeuasis Publishing, © 2007), is a readable and useful addition to the general literature on how to be a good editor.

Editor’s Note: To learn more about the book: http://www.geoff-hart.com/home/onscreen-book.htm(external link). To purchase a copy of the book: http://www.geoff-hart.com/download/buy-eoe-book.htm(external link). Geoff is currently revising the book to incorporate review comments that he’s received, fix some infelicitous wording, and incorporate some new stuff he’s discovered since the book was released. Details of these changes and corrections at: http://www.geoff-hart.com/resources/eoe-may2007-errata.htm(external link). The new version should be available online by 11 January 2008 if all goes well. At that time, all purchasers of the previous version will be contacted and offered a free upgrade to the new version.

His main points are that onscreen editing can be fast and effective and can reduce errors when edits are incorporated.

Three of the main topics of the book are what onscreen editing is, what its advantages are, and how to implement it for yourself and introduce it to your team. The focus of the book is how to edit onscreen using Word for either the PC or the Mac.

The book describes using the software tools, editing nonstandard files, editing with software other than Word, finding and using research sources, and safeguarding your work and health. Other topics include information on working with clients and additional detail about Word software.

The book has two primary audiences:

  • Those who have never edited onscreen and need to know how and where to begin, how to be effective, and how to use the tools
  • Those who are currently editing onscreen but want hints and tips on how to be more effective, both with tools and with clients

Most of the information on tools, basic editing techniques, Internet resources, security information, and health concerns is available but can only be found in separate sources. Geoff Hart’s contribution is to bring these topics together in one manageable book and to explain them from an editor’s point of view. He has done an excellent job of describing not only how to be an effective onscreen editor, but also why this methodology is advantageous to our profession. Those managers and editors who are new to this kind of editing can use this book as a set of guidelines to help them understand why and how to implement this technique. Those who already are familiar with onscreen editing can browse to find specific information on new tools, new ways to use familiar tools, how to work with nonstandard files, and much more.

The book has a strong emphasis from the point of view of an independent editor and provides a great deal of information on working with clients. Many of the issues are not relevant to editors in a corporate environment but can be easily passed over.

The chapters on tools, resources, and security provide clear procedures and workarounds. Geoff Hart covers all the tools in Word and how to use them effectively and efficiently. I knew many of them but was surprised and delighted to find some new ones. I also found several ways to improve my use of some of my current tools, such as search techniques, creating effective comments, and using style sheets and exclusion dictionaries. In most cases, I had to test several of the recommendations, which slowed down my reading, but proved that the time and effort were well worth it. For example, on page 215:

“Word offers a nifty shortcut that can quickly reveal whether a global search and replace operation would be safe. Type the search term in the “Find what” field. Then select the option “Highlight all items found in”, immediately below this field, and use the dropdown menu to specify where Word should search for that term (e.g., the main document, headers and footers, comments). Clicking the “Find All” button will highlight all matches in the text in a single step.”

The differences between the PC and the Mac are clear and helpful and are not disruptive. He also covered other software, which makes the book more valuable, especially if you are working with clients who have older or less conventional systems.

Overall, he had good discussions of various editing techniques and especially of Internet resources: how to find them, how to use them, and how to establish the credibility of the source. For example, on page 410:

“As a general rule, give precedence to sites with clear and rigorous editorial policies for controlling the quality of their data.”

In particular, I was pleased to find excellent suggestions for editing less common files, including databases and spreadsheets, as well as Web pages, ASCII, and RTF files. The information also covers editing different tagging languages such as SGML and SML. For example, on page 336:

“The key to opening our horizons wide is the following: most applications, in addition to saving files in their own proprietary format, can also save their files in a range of other formats.”

One of the most important chapters was on the need to save and back up work regularly, as well as make external copies. This chapter also included valuable information on confidentiality, for the client as well as for you.

I do have a few minor criticisms. Three chapters seemed out of place. Chapter 3 is about client relationships, not directly with onscreen editing. It’s important, but I would have made it an appendix. Chapter 13 is about Internet resources. Again, this material is important, but it is not directly part of the onscreen editing process. I would have put it either after the safeguard information or in the appendix portion. Chapter 15 concerns information on backups, upgrades, confidentiality. This information is important information, but it is placed between two chapters directly addressing onscreen editing. I would have made this the last chapter before the two chapters on how to get started with onscreen editing.

I struggled a little with the overuse of long sentences with semicolons. The sentences were all grammatically correct (although I object to the use of “then” as a conjunction). But I found that the long sentences were harder to read, and I frequently had to go back to reread the second clause to make sure that I understood the point.

But these criticisms do not take away from the value of the book. None of the information is extraneous. It is written to editors (and managers) by an experienced editor who has clearly drawn together all the pieces of the work environment that we face daily. He has explained how to make our work easier and more valuable, and has given us a lifeline in a field in which we all sometimes feel we are flailing alone and in the dark. Thank you, Geoff.

STC Summit 2007 Report

Virginia Janzig

I attended the STC Summit for the first time in about 10 years. In addition to being a presenter in the Editing Progression, I attended many of the sessions that were offered, and spent worthwhile time in the vendor showcase, especially the bookstore.

Three things stand out to me.

First, the organizers had clearly paid attention to the comments received about prior conferences. The  conference was more focused on writing and editing, and much less on tools. And the variety of different kinds of writing topics was tremendous: everything from processes and procedures and structured language to highly technical online documentation. Having recently taken a job in a courseware development group, an area about which I know very little, I was pleased to find more than one session on instructional design. The two I attended were quite helpful.

The editing progression had several presenters on a wide range of topics, and it was well attended. A couple of other sessions on language were also well attended and useful, as well as entertaining. And our language is nothing if not entertaining.

Second, several sessions on various topics provided information for both beginning and advanced writers. Assessing an audience and its needs is always a challenging task, but I think that the organizers and presenters did an excellent job of delivering to both ends of the spectrum.

Third, I was especially glad to see sessions on careers, not only what kinds of careers are available in the technical documentation arena, but also how to progress in a career: what opportunities to look for, how to build skills, and how to present yourself (not just your resume) in a professional and business-like manner.

The Minneapolis Convention Center was a great venue, and the city had a lot to offer. There were plenty of rooms for all of the sessions (although a few of the most popular were standing room only), and the vendor showcase area had refreshments and Internet access. The incredible walkways made it really easy to get from hotels to the convention center and to lots of other businesses.

In closing, I was pleased to see how many young people attended the conference. Clearly, technical documentation is perceived as a legitimate career and career path, and, if we can help persuade the U.S. Department of Labor to update its definition of this job, then I think that the STC and technical documentation as a whole will benefit, and the technical community will be well served.