1

BIME writing style guide

If you are looking for help writing your tips, this article contains information on proper capitalization and usage for BIME terminology. For guidelines on general word usage and capitalization, see Zendesk's Basic writing guidelines.
 
Note: Capitalization and terms are subject to change in coming months. The style guide will be updated with the changes. 

This article contains the following sections:

Capitalization rules

Below is a list of general capitalization rules. If you are unsure of the capitalization for a specific term, see the Term capitalization table below.

  • Don't capitalize randomly. Use lowercase unless there's a specific reason for capitalizing.
  • Capitalize feature names, such as BIME Scheduler or Query Builder. See the word list below if you are unsure.
  • Do not capitalize specific filters, calculations, or result manipulations (standard calculated metric, top/bottom filter, forecast result manipulation). Capitalize the first word if in reference to the menu or option name.
  • Capitalize the first letter for destinations in the user interface, such as the Dashboard customization menu or Admin menu. If destinations are not in sentence capitalization in the product, follow the product's capitalization.
  • Capitalize individual metric, attribute, or attribute values name when referring to them in an example. Select the Profit metric from the drop-down list for destinations in the user interface.
  • Only capitalize the first word in titles and headings.
  • Sources in Data sources is never capitalized.
  • Capitalize a trademark term or to respect a trademark registered by another company.
  • Capitalize industry-standard terms only if the rest of the industry does so. Search the American Heritage Dictionary, the Internet, and industry-specific dictionaries. Do not consult on unedited websites.
Table 1. Term capitalization
Term Capitalize? Reason
admin No Common noun with thousands of instances.
Admin menu Yes UI destination.
attributes No Industry standard.
auto-mode No Common noun with thousands of instances.
axis of analysis No Industry standard based on the term analysis axis.
big data store No In industry spelling, this is usually not capitalized.
BigQuery Yes BIME feature name.
BIME Yes Zendesk capitalizes BIME. 
BIME Scheduler Yes BIME feature name.
Managed Storage Yes BIME feature name.
cache No Common noun with thousands of instances.
cc No Common noun.
Chart configuration menu Yes UI destination. This applies to all menus and pages. (Visualization type menu, Calculation engine menu, Result manipulation menu, etc).
Columns Yes UI destination. This applies to all areas to place elements in the Query Builder (Rows, Metrics, etc).
connection No Common noun with thousands of instances.
dashboard(s) No Common noun with thousands of instances.
Dashboard Builder Yes BIME feature name.
Dashboards library Yes UI destination.
Dashboard portal Yes UI destination.
data sources No Common noun with thousands of instances.
Data source Builder Yes BIME feature name.
decompose/drillthrough; focus No Industry standard; common noun.
Déjà Vu Yes Feature name.

dual axis

No Common noun with thousands of instances.
elements No Common noun with thousands of instances.
Google Analytics Yes Google trademark name
Help Center Yes BIME/Zendesk feature name; proper noun.
ID Yes Industry standard.
JavaScript Yes Industry standard.
knowledge base No Common noun with thousands of instances.
metric No Industry standard.
query/queries No Industry standard.
Query Blender Yes BIME feature.
Query Builder Yes BIME feature.
Queries library Yes UI destination
RDBMS Yes Industry standard.
editor No Common noun.
result manipulation No Common nouns with thousands of instances.
Row Selector Yes BIME feature name.
SQL Designer Yes BIME feature name.
standard calculated metric No Only capitalize the first word when in reference to the option in the Calculation engine menu. Same for all other calculated metrics.
top/bottom No Only capitalize the first word when in reference to the option in the Calculation engine menu. Same for all other calculated metrics.
user No Common noun with thousands of instances.
viewer No Common noun with thousands of instances.
Visualization Selector Yes BIME feature name.
widget No Common noun with thousands of instances.
website No Common noun.
     

 

Usage dictionary

This topic contains a list of word usage for BIME. For more general word usage or Zendesk specific, see Usage dictionary.

viewer, named user, named viewer, dashboard viewer

Us viewer.

viewer groupnamed viewer group, name user group, named user group publishing

Use viewer groups. For publishing use phrases like, "Requires sharing with named viewer groups".

connector, connection, data sources

Only use connection if referring to an already imported data source.

Limit the use of the word connector, since it's not mentioned in the product. Instead of "Select a connector type" say "Select your data source's icon."

editor, studio user, owner, admin

Use owner for the account/dashboard owner

Use admin for a user who is an admin.

Use editor for users with editing permissions that you created in the Editors menu. 

Do not use studio users

axis, axes, axises

Use axis as singular (X axis, Y axis).

Use axes to represent more than one axis (Using metrics as axes).

Do not use axises.

data

Use as either singular or plural in meaning but always with a singular verb. In other words, always use “the data is” (or another appropriate verb) whether you mean a collection of facts (plural) or information (singular). If you want to emphasize that something is plural, rewrite to use a term such as facts or numbers.

top/bottom, top bottom, top & bottom

Use top/bottom to reference a top/bottom attribute or feature. Only use as separate words in sentences like "You can filter the top 5 and bottom 3 values."

result manipulation, Result manipulation menu

Result manipulation menu refers to the menu containing the result manipulation options. It is always capitalized.

result manipulation refers to the individual result manipulations such as forecasting, totals, and result path calculation.

Visualization type menu, visualization types, visualization selection

Visualization type menu refers to the menu contains the different chart options. It is always capitalized.

visualization types refers to the different chart types.

Do not use visualization selection . Use Visualization type menu instead.

query, report

Only use query when referencing a specific query created in the Query Builder.

Use report before the data becomes a query or as a generalization. For example, BIME can help you create compact reports to easily analyze data.

drop-down

Always hyphenated.

end user, end-user

Use end user as a noun and end-user as an adjective.

log in, log out

Don't use. Use sign in and sign out instead.

sign in, sign out, signed in, signed out

Two words as verb. Hyphenate as an adjective or as a noun.

user name

Two words.

time zone

Two words, lowercase

timestamp

One word, lowercase.

web page

Two words, lowercase.

set up, setup

Two words as a verb, one word as an adjective or noun.

ampersand (&)

Don't use & in text or headings to mean and unless you are specifically referring to a symbol in the user interface.

all of

Saying all of is usually incorrect because it’s redundant. Just say all.

click on, click at

Don’t use. Just use click instead. For example, "Click Preview."

appears, displays

Displays is a transitive verb, meaning that the action transfers to something else. For example, a screen displays an image. Whiledisplaysrequires a direct object, appears does not. For example, an image appears on screen.

e.g., eg

Abbreviation for exempli gratia, meaning for example. Don’t use. Use for example instead.

i.e.

Abbreviation for id est, meaning “that is.” Don’t use. Use that is or in other words instead.

subdomain

One word.

tweet

Lowercase. Twitter, however, is uppercase.

workflow

One word.

ungroup, un-group

Use ungroup.

0 comments

Please sign in to leave a comment.