Definitions in Technical Communication

Have you every wondered what an instructional designer really does? What's the difference between a proofreader and an editor? In an ongoing column, volunteer writers for the Willamette Galley will provide their definitions of technical communication terms. Enjoy!

Editing

Editing can be defined as creating error-free writing. The editor will assure that the original document has been checked and corrected for any or all of the following components:

1. Grammar, punctuation and spelling
2. Accurate content
3. Audience appropriate language
4. Overall document organization
5. Proper style format
6. Concise language
7. Clearly articulated language

Java

A programming language developed by the Sun Corporation. Java is called an object-oriented programming language because it is platform-independent; meaning that it is not written for a specific end-user system and once compiled the code can run on many different types of operating systems. Independence from the end-user's system is achieved through the use of the Java Virtual Machine (JVM), which operates on a server and acts as an interpreter for the system attempting to read the code.

JavaScript

A Netscape product, JavaScript is a scripting language that extends HTML. JavaScript is based loosely on the Java programming language. JavaScript programs are contained within the HTML code of the Web page and are interpreted as they are downloaded by the user's browser. By contrast, Java programs are downloaded separately from the HTML page.

Localization

Translating documentation in multiple languages. Competitive businesses use localization to improve their international communication, training, and production.

Proofreading

Proofreading is reading and marking corrections on a proof or other copy of the text of articles and books before publication. Proofreading can include checking for basic spelling, grammar, and punctuation.

RoboHelp

A software program used by technical writers and Help authors in the development of online Help and system software Help. RoboHelp assists in the creation of tables of contents, indexes, search features, and glossaries. RoboHelp standardizes the look of Help systems with its recognizable split screen view that maintains the table of contents, index, search, etc. capabilities on the left while the topics are displayed on the right.

Technical Communicator

Simply put, a technical communicator writes and designs information. Technical communicators produce documents that communicate information to users of products or readers of documentation. They often draw on multi-disciplinary skills to do this, incorporating audience and data analysis, organization and development, writing and editing, graphic design, markup languages, and software packages. Good personal skills are also desirable for a technical communicator.