High-tech publications need old-fashioned editing

  • Authors:
  • Janis Ramey;Marlene Miller

  • Affiliations:
  • Ramey Technical Writing Services, Pittsburgh, PA;3817 Winterburn Avenue, Pittsburgh, PA

  • Venue:
  • IPCC/SIGDOC '00 Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork
  • Year:
  • 2000

Quantified Score

Hi-index 0.00

Visualization

Abstract

Standard formats, familiar word choices, consistency, organization, simple graphic formats, technology, mechanics, and the global nature of the user and the media are major considerations that are often ignored when producing high-tech publications. Oversights and errors are usually corrected in print publications with conventional editing as a step in the production process. However, the authors noticed during a recent Society for Technical Communications chapter publications competition that many creators of websites, online help, and other electronic publications appear to skip the editing step when producing their documents. Applying old-fashioned editing techniques such as following a style guide, proofreading, testing links, and trying to look at a document with a fresh perspective could have made these publications winners.