Don't pluralize single letters, symbols, or mathematical signs by adding an apostrophe and an s.
When referring to a symbol, spell out the name of the symbol and then enter the symbol in parentheses after it.
|
For user documentation and UI text, use the second person, you, which makes the writing more informal and personal.
|
Avoid if possible by rephrasing your content into shorter, simpler sentences. If needed, a semicolon can be used to:
Place semicolons and colons outside quotation marks and parentheses. |
Setup is a noun or an adjective. Set up is a verb phrase.
|
Sign up is a verb. Sign-up is an adjective or noun. Don't use signup. For example:
|
|
|
Don't capitalize in general usage. For example, it would be "Payments subtab" instead of "Payments Subtab." Use sentence case capitalization for subtab names. |
Use support representative to refer to a customer support user. Don't use rep, support rep, customer support representative, support agent, or customer support agent. |
Use sync instead of synchronize or synchronization in general use. You can also use resync. The following terms are related to whether transactions in a group are executed one at a time (synchronous) or at the same or overlapping times (asynchronous). Spell them out:
|
The proper term to use when describing an action involving choosing an option from a dropdown menu, a radio button selection, or a checkbox. “Check” is not correct. |
Things customers purchase from us, such as training, Cloud-Hosted services, technical support services. It can also be used as a technical term relating to the capabilities of the server and how its clients initiate server operations. |
A site is an individual library or school. Site preferences are local and only affect one database. Site ID is the official term as of 20220310. Not Site ID Code, or Site Code. You can call it a site code though. |
SIF ensures that K-12 instructional and administrative software applications work together more effectively. It reduces the redundancy of data entry and allows data to be efficiently exchanged among different applications using a standard set of specifications. |
SIP2 allows you to utilize SIP2 hardware (e.g. Checkpoint, 3M, etc.) by supporting the SIP2 protocol. Make your library more efficient with enhanced inventory and security features. Empower your patrons with self-service check-in and check-out modes, allowing you more time to focus on patron information needs. |
global; things that affect more than 1 database |
They should always be considered System Patrons; being “special” has too many unfavorable connotations. |
Self Hosted (previously Alexandria Customer-Managed, then Self-Hosted) When customers purchase Self Hosted (On-Premises) and various Alexandria licenses, they are responsible to install, define DNS access, update, and backup themselves. In other words, customers must manage their own installation and operations. As opposed to Cloud Hosted where we manage their data. Self Hosted should be used without a hyphen, except as a descriptor e.g. "your self-hosted servers". |
Snackbars inform users of actions the app has performed or will perform. They appear temporarily at the bottom of the screen. |
The sidenav is the navigation menu on the left side of the screen. It contains links to major modules/areas and displays randomized app tips at the bottom. It can be collapsed or expanded. |
Groupings of information within Details pane tabs. These are primarily found in Patrons Management and Items Management. |
A dropdown menu that allows the user to specify how results or information is sorted. Patrons and Items Management each have a Sort dropdown above the Record List. |
A button that allows users to choose between a descending or ascending sort order for the Patrons/Items Management Record List's results. It's located above the Record List and is represented by an icon consisting of an A, Z, and arrow. |
Settings are lower-level sets of individual preferences; they are not usually used site-wide. These include Self-Service and Activity station settings, Patron Status avatars, and operator account settings. |
Operations automatically scheduled and run because the system's code told it to, independent of any saved/scheduled operations or operator action. These are associated with the union site and System Administrator. Examples: daily|weekly|monthly maintenance, (automatic) archives, authority control updates, D2 search values updates, various record validation routines, demo restores, etc. System operations that are handled by operation management for the purpose of queuing it so that it runs in order rather than at the same time as other things already being done by operations management will have an associated summary file and appear on the /operations page. |