
![]() |
- a - a lot of abbreviations above AC adapter accessories section in hardware user assistance accurate acronyms action buttons activating active voice adapters add-ins add-on adjectives administrators Adobe Air Help Air Help aligning alignment allow allowed to alphabetical index section in hardware user assistance section in software user assistance although amateurish formatting ambiguity among amount and and/or animation apostrophes AppleHelp applets application tips section in hardware user assistance applications as as well as assembly instructions section in hardware user assistance assistants associations assume assumption attaching attributes audio editing tools automation tools AZW - b - back cover section in hardware user assistance section in software user assistance backup because below between big blacklist block labels blogs boards body page body text bookmarks books on technical documentation in general booting boxes breadcrumb trail browse sequence browser-based help browsing bugs bulleted lists burning discs but buttons buzzwords - c - cables calling help can can not can’t cannot capitalization card CAT cautions chapters character styles characters, special cheat sheets section in hardware user assistance check check boxes CHM clicking clients clipart closing clutter code colloquial expressions colons color columns combo boxes command buttons command line command links commas comments commercial software common words communities for technical writers community features compare to compare with compatibility complex terms compose comprise computers concept topics concepts section in hardware user assistance section in software user assistance concise conferences confirmations conformity section in hardware user assistance connecting consistency constitute content content management tools contents context menu continual continuous contractions control controlled language controls copying files cost could cover back cover as section in hardware user assistance back cover as section in software user assistance front cover as section in hardware user assistance front cover as section in software user assistance creativity tools cross-references CSS editors cues curly quotation marks customer assistance section in hardware user assistance section in software user assistance cutting - d - danger notices dashes data deactivating declaration of conformity section in hardware user assistance default defaults definite definitive deinstallation deleting design designing desire desktop desktop publishing tools developer jargon device description section in hardware user assistance dialog boxes dialog windows dialogs diction dictionaries different different from different than directories disabling discreet discrete discs disks display disposal section in hardware user assistance distinct distinctive DITA DITA tools do document sections choosing for hardware user assistance choosing for software user assistance documents double-clicking downloading drag and drop dragging drivers drives drop-down lists drop-down menus DTP tools - e - each Eclipse Help ed editors effective efficient elements ellipses em dash embedded help embedding help emphasis employ empty pages en dash enable enabling encyclopedias section in software user assistance ending entry fields environmental protection section in hardware user assistance EPUB error messages errors EU conformity section in hardware user assistance section in software user assistance every examples exclamation marks exclamation points executables exhibitions exiting - f - failure fair language farther fat favorites feeds fewer fewer than fields figure figures table of figures as section in hardware user assistance table of figures as section in software user assistance file format files filler words find and replace tools firmware flat focus folders foldout pages fonts footers format choosing format of online help formats formatting avoiding amateurish formatting forums for technical writers freeware front cover section in hardware user assistance section in software user assistance full-text search further future tense - g - gender neutral language gerunds avoiding if they conceal a direct verb getting started section in hardware user assistance section in software user assistance glossary section in hardware user assistance section in software user assistance goals grammar grammar checking tools grammars graphic graphics graphics editors great group boxes guides - h - handhelds hardcopies HAT have to hazards header headers heading headings help choosing format for online help Help 3 help authoring tools help compilers help formats hints history HLP however HTML editors HTML Help hyperlinks hyphen hyphenation - i - icons idiomatic expressions idioms if if-clauses illegal image image editors image processing tools images section in hardware user assistance section in software user assistance in in case in case of in to index section in hardware user assistance section in software user assistance indexes indicator lights indices information information design information paths information types initial start-up section in hardware user assistance input input devices insertion point installation section in hardware user assistance section in software user assistance interaction design interactive features interface controls Internet into intranet invalid isn’t It … it isn’t it’s not - j - jacks jargon JavaHelp judgments justified text - k - key combinations keyboard keyboard shortcuts keys knowledge management tools - l - labels language checking tools large lay layout leave LEDs left-aligned text left-clicking section in hardware user assistance section in software user assistance legal issues length less less than let letters license acknowledgements section in software user assistance license agreement section in software user assistance lie like line breaks lines links Linux list boxes list of figures list of tables list views little localization logging in/out lots of - m - Mac machine translation tools machines macro recorders mailing lists for technical writers main clauses tips for including information main point maintenance section in hardware user assistance make manual formatting manuals many margin column margins common according to design grid may media menus message boxes messages Microsoft Help Viewer might migration tools modifiers monitor more than mouse pointer mouse, mouse devices MSHC much multimedia multiple information paths must must not - n - names character style for product names navigation part labels and section labels need need to nested sentences networks networks for technical writers newsfeeds norms notes room for in hardware user assistance room for in software user assistance notification area notifications nouns number numbered lists numbers - o - of the offline on onboard online online help tools for embedding and testing online help authoring tools open source software opening files option boxes option buttons optional components section in hardware user assistance optional plural options Oracle Help order organizations orphan control outline over overblown words - p - package contents section in hardware user assistance page breaks page margins common according to design grid page numbers page size pages pagination panes paper size paragraph styles paragraphs parallelism parameters parentheses part dividers part labels parts included section in hardware user assistance passive voice pasting paths PC PDF creators PDF editors pens percentages perform peripheral device permissions photographs phrasal verbs picture plain language please plug-ins plugs plurals plus plus/minus buttons pop-up menus ports positive possessives of companies, products, features power adapters power buttons power switches precise preface section in hardware user assistance section in software user assistance present tense preset presets pressing keys presume presumption previous price primary user group identifying for designing structure printed manuals printing designing electronic documents prior privileges problems procedures section in hardware user assistance section in software user assistance product names production tools professional organizations program code programs programs (tool guide) for creativity and productivity for embedding and testing help for HTML authoring and conversion for PDF creation and manipulation for translation and localization progress indicators progressive disclosure controls project management tools proper use section in hardware user assistance pull-down menus punctuation push buttons - q - qualification quick access toolbar quick launch bar quitting quitting applications quotation marks - r - radio buttons recommendations redundancy finding the right amount of on structural level using purposefully within sentences reference information section in hardware user assistance section in software user assistance reference topics reference works registry regular regulations relations releases remarks removing rendering tools repetitions requirements resizing resources ribbons right-clicking room for notes section in hardware user assistance section in software user assistance running footers running headers running programs runtime - s - safety safety instructions section in hardware user assistance saving screen screen capture tools screen captures screen dumps screen grabber screen recording software screen shots tools for creation (tool guide) screencasting scrolling search search and replace tools section labels sections choosing for hardware user assistance choosing for software user assistance security selecting semicolons sentence length sentences separator pages service section in hardware user assistance section in software user assistance setup section in hardware user assistance section in software user assistance short words shortcut menus should shutting down signs simplicity simplified English since single singular size skimming sliders slots small smothered verbs so social features societies sockets software software (tool guide) for creativity and productivity for embedding and testing help for HTML authoring and conversion for PDF creation and manipulation for translation and localization software demos software license acknowledgements section in software user assistance source code spacing spare parts section in hardware user assistance special characters specific specification section in hardware user assistance spell checking spelling spin controls spine splash screen split bars splitting stacks of modifiers standard standard users standards start button start menu starting startup screen status areas status bars status displays stepped procedures stopping storing strings of nouns strong strong verbs structure structuring choosing document sections for hardware user assistance choosing document sections for software user assistance style guides styles subdirectories subfolders subheadings subjects submenus subordinate clauses tips for including information subtitles such as superlatives supporting switching on/off symbols system system requirements - t - tab cards table of contents section in hardware user assistance section in software user assistance table of figures section in hardware user assistance section in software user assistance table of tables section in hardware user assistance section in software user assistance tables table of tables as section in hardware user assistance table of tables as section in software user assistance tabs task topics taskbar tasks technical documentation technical documents section in hardware user assistance technical terms technical writing templates tenses terminology terms testing help text text boxes text editors text fields text processing tools text replacement tools text-to-speech engines that the … of then There … therefore these this those thus tips section in hardware user assistance title page section in hardware user assistance section in software user assistance titles TMS TOC toolbars toolkits tools tools (tool guide) for creativity and productivity for embedding and testing help for HTML authoring and conversion for PDF creation and manipulation for translation and localization tooltips topic area topic titles topic types distinguishing information types topics touchpads touchscreens trade fairs trademarks character style for product names transformation tools translation translation memory systems tree views trendy terms troubleshooting section in hardware user assistance section in software user assistance TTS tools turning on/off type area typefaces typing typographical quotation marks typography - u - UA under uninstallation units units of measure Unix updates upgrades uploading upon usability use user assistance user experience user input user interface controls user interface design user rights utilities utilize UX - v - vagueness valid value variables variety various verbosity verbs version numbers versions video capture software video editing tools video screen capture tools video screen recorders - w - want warning signs warning symbols warnings warranty section in hardware user assistance weak verbs web web 2.0 features web applications web sites what what’s new section in hardware user assistance section in software user assistance when whereas whether whether or not which while who whom widgets widow control wiki wiki tools windows Winhelp wish within wizards word choice word order words workstations worth writing writing files writing style guides www - x - XML XML tools XPS xrefs - z - zooming |
