Glossary

Authoring Tool: Software used to create Help files. At TechWRITE, we use a variety of authoring tools including RoboHELP, FrontPage, Adobe Acrobat, Corel WebMaster Suite, Doc-To-Help, ForeHelp, Framemaker, Hyperties, etc.  

Bitmap (.BMP File): A graphics file format. We use this format when we capture "screen shots" of your application for use in your Help file.  

Back Button: The button on the Help menu bar that takes you back to the topic you looked at prior to the current topic.  

Browse Buttons: The Next button and Previous button on the Help button bar. The Next button lets you move forward to the next topic in the sequence; the Previous button lets you move backward to the previous topic in the sequence.  

Context ID: Unique numbers, assigned to each topic within the Help file. If a software application can display context-sensitive help, programmers use the Context IDs to link the help topics to the places in the application where this information can be accessed.

Context-Sensitive Help: Context-sensitive help is intelligent help that you can access directly from within your software application. In a software application with context-sensitive help, each dialog box typically has a Help button. When you click on that Help button, the screen displays information designed to help you with that specific dialog box.  

Conventions: A set of formatting or stylistic standards that apply to a specific document or online Help file.  

Design: The phase at the beginning of a documentation project that involves planning the organization and formatting of the manual. If the manual is online, the design phase also includes developing the linking structure.  

DLL: Dynamic Link Library. DLLs are Windows programs that can be accessed by a Help file to expand its capabilities. For example, the full-text search function requires a specific DLL.  

Full-Text Search: The search capability that allows users to search for any and all words within the online manual. If your Windows Help file has a full-text search capability, this button appears in the Help menu.  

Graphics: Pictures or illustrations that appear in an online or hard copy manual. Often graphics are pictures of computer screens (screen shots) or drawings used to illustrate complex concepts.  

Glossary: A list of specialized terms and their definitions. In a hard copy manual, the glossary is typically at the end of the manual. In a Windows online manual, if there is a glossary, this button appears in the Help menu.  

Footers: Identifying information printed at the bottom of each page. The footer generally contains the date of the document, the page number, and sometimes the manual name and section title.  

Headers: Identifying information printed at the top of each page. The header normally contains the topic (or topic and subtopic) discussed in that section of the manual.  

Headings: The titles or subtitles within an online or hard copy manual. Headings serve as guideposts for the reader. They divide the text into manageable segments and indicate levels of importance.  

Help Button: A button on a dialog box or system message box that displays an associated Help topic.  

Help Compiler: Software that generates the Help file from text, graphics, and other files.  

Help File: A hypertext file. Although Help files typically explain how to use software applications, Help files can contain any type of information. Windows Help files have .HLP file extensions.  

History Button: A button at the top of a Windows Help file that, when clicked, displays a list of the Help topics you have accessed during the current session.  

Hypertext: The presentation of information on a computer screen that allows you to link to related topics, usually by clicking on a highlighted word or picture.  

Index: An alphabetical list of all topics discussed in an online or hard copy manual. In a hard copy manual, the index appears at the end of the book and provides page numbers for each topic. In an online manual, the words listed within the Search function have the same purpose as the words within a hard copy index. These words take you to the place in the online manual where you can find information about the selected topic.  

Index Tabs: Special pages (that often extend beyond the edge of the document) that are inserted into a hard copy manual to separate major sections.  

Jump: A link which takes you to another topic within the online manual.  

Keyword: A word or phrase that appears within the Search function's list. When you double-click on a keyword, the Help system moves to a topic containing information about that keyword.  

Map: A section of the project file used to link topic IDs to context IDs, which are required for building context-sensitive help.

Nonscrolling Region: An area at the beginning of a Windows Help topic that remains stationary when the rest of the topic scrolls.  

Online: The delivery of information on a computer.  

Perfect Binding: A binding technique where the cover is wrapped around the document and the pages are glued to the inside of the spine.  

Pop-up Window: A small window that is displayed on top of the main window.  

Prototype: A trial model of the finished project that typically shows, in one small section, most of the features that will be used throughout the entire project.  

Quick Reference Card: A short form of hard copy documentation (typically printed on card stock) containing information that is often required but easily forgotten (for example, keystrokes).  

Quick Start Guide: A small manual or a section of a larger manual that provides the minimum amount of information necessary for people to begin using a software application.  

Rich-Text Format (RTF): The format used for Help topic files. RTF files contain the text and describe paragraph formatting, page dimensions, etc.  

Saddle Stitching: A binding technique whereby a document is printed "two-up" on a press, and sheets are folded and stapled or stitched in the center.  

Screen Shots: Illustrations of computer application screens that are created by electronically "snapping" the images of the screens.  

Secondary Window: One of two types of windows used to display Help information. A secondary window is a smaller window that can be displayed along with the Main window.  

SHED: Segmented Hypergraphics Editor that is used to create hotspots on graphics.  

Society for Technical Communication: The major international professional organization for technical communicators (technical writers and editors, visual designers, their managers, and educators, etc.).  

Table of Contents: The chapters or sections in a manual listed in order of appearance along with their page numbers. The Table of Contents appears at the beginning of a hard copy manual. Online manuals also can have a Contents page, which is similar to a Table of Contents.  

Topic: The basic unit of information in a Help file.  

Tutorial: A hard copy or online manual that teaches you about a software application by providing step-by-step instructions for performing sample tasks.  

User's Guide: A hard copy manual consisting primarily of procedures.  

WinHelp: The software used to read Windows Help files.

Return to Writing and Editing

 

To learn more

To learn more about how we can help you, click here or call us at 856-848-6593 or send us an e-mail