Skip to main content

Smart Abbreviator User Manual

Version: 1.0 / Issued: June 5, 2026

Smart Abbreviator is a Word add-in that extracts and reviews abbreviations in Microsoft Word documents and helps you create abbreviation tables and register entries in an abbreviation dictionary. It is designed primarily to improve the quality and efficiency of abbreviation management in pharmaceutical document authoring.

This manual is the user's operating guide for the Office.js (web add-in) edition of Smart Abbreviator.

Intended audience

  • Staff who create and review abbreviation tables in Word documents
  • Staff who reference and update abbreviation dictionaries (Excel files on SharePoint)
  • Administrators who aggregate and manage abbreviation dictionaries

System requirements

CategoryRequirement
OSMicrosoft Windows 11
WordThe Windows desktop edition of Word in Microsoft 365
NetworkAn internet connection is required for license authentication and SharePoint access
DisplaySupports light and dark modes

Note: This add-in is supported and verified on the Windows edition of Word only. The Mac and Web editions of Word are out of scope for this release (support is under consideration for the future).

How this manual is organized

  1. Overview — Product purpose and main features
  2. Installation and startup — Installation, startup, license authentication, display language
  3. Basic workflow — Task pane layout, loading, reading the grid
  4. Creating an abbreviation table — Core operations from loading to table creation
  5. Dictionary registration — Saving to the abbreviation dictionary and registering exclusions
  6. Dictionary management and Master aggregation — Administrator features
  7. Settings and rules — Extraction, check, and output settings
  8. Notes and limitations
  9. Tips
  10. License and support
  11. Revision history

Notation conventions

NotationMeaning
[xxx]The name of a button, menu, or other operation (control).
"xxx"A value within a control or a string shown on screen.
abbreviationAn abbreviated term in the document (e.g., AI).
full termThe official name of an abbreviation (e.g., Artificial Intelligence). Each has an English term and a Japanese term.
abbreviation dictionaryAn Excel file (.xlsx) that holds abbreviations and their English and Japanese full terms. Operated as a hierarchical dictionary.
hierarchical dictionaryAn abbreviation dictionary that merges the Master, Project, Personal, and auxiliary layers according to priority.
task paneThe add-in's operating pane (work pane) shown at the side of Word.
abbreviation gridThe table in the task pane that lists extracted and added abbreviations.
rulesThe set of settings that govern extraction, checking, saving, and other behavior. Applied as the merged result of the organization-wide "Master rules" and each user's overrides.
full-term checkThe feature that checks the document for deviations from full-term notation rules, such as missing, mismatched, or duplicated full terms.
repair issueA notation-rule deviation, detected by the full-term check, that is subject to repair.
ribbonThe command bar at the top of Word. This add-in adds a button to the Home tab.