What would you like to know more about?

Show Page Sections

Style Usage and Formatting

Acronyms and Abbreviations

An abbreviation saves time and space, but it is important for the reader to know what it stands for.

When possible, give the complete term first and follow it with the shorter term in parentheses. Once the complete term and the abbreviation are given, you can use the abbreviation through the rest of the document.

  • The National Association of Church Business Administration (NACBA) meets yearly.

For terms that are well known (example: IQ), it is not necessary to use the complete term.

Precede the acronym or abbreviation with the correct article (a or an) depending on the usual pronunciation of the acronym.

  • For a North Carolina State University professor, use "an NCSU professor".

  • For a study by the North Atlantic Treaty Organization, use "a NATO study".

To make acronyms plural, add a lowercase s. Do not use an apostrophe.

  • DVDs, JPEGs, PNGs

Do not abbreviate the names of academic institutions.

  • University of South Carolina, not USC.

IRS Tax Forms

Use official IRS form descriptions (Form W-2, Form W-4, Form 941, Form 1040, and so on

Problem: Use a W2 form to calculate annual gross income.

Solution: Use Form W-2 to calculate annual gross income.

(See www.irs.gov for more examples.)

Note: In our content meeting on 10/7, we discussed this. To keep content more conversational, we chose not to put "Form" in front of the form type unless we think it's necessary. Just putting this here as a reminder of what we talked about. Opinions around this are subject to change.

Latin Abbreviations

Use the English equivalents (see e.g., and i.e.). Do not use etc. (et cetera)

Instead of...Use...
e.g. (exempli gratia)For example, ...
i.e. (id est)that is to say, what that means is
viz. (videlicet)that is..
et al. (et alii )and others, and other people
See a list of common Latin abbreviations online.

Bulleted Lists

Customer-facing materials use simple solid bullets at the first level, open hole bullets at level two. (Bulleted lists are also referred to as unordered lists in DITA XML).

Begin each item with a capital letter, whether it is a sentence or a fragment. Do not use periods unless an item itself forms a complete sentence. If a single item requires a period, use periods for all items on the list.

Before you start, gather this information:

  • Tax Identification Numbers
    • Church
    • Daycare
  • API keys
  • Scissors
    • Paper shears
    • Pinking shears

Capitalization in Captions

When adding figure or table captions, use initial capitalization on the first word in a caption.

For window titles in a caption, match capitalization in the user interface. Do not capitalize the word window.

Table 1. Table caption example
FruitVegetablesProtein
ApplesRed CabbageBeef
OrangesCarrotsSalmon
GrapesEggplantsEggs

Capitalization in Headings

Use initial capitalization for every word in a topic or printable title (except for prepositions, articles, and conjunctions). See [NO TITLE FOUND].

For all other headings, such as table titles and column headings, use initial capitalization only on the first word.

Setting up Permissions in General Ledger

Capitalization in Lists

Use initial capitalization for the first word in each list item whether the item is a complete sentence or not.

The purposes of these options are:

  • To calculate the funds

  • To update the data

Capitalization of UI Elements

Capitalize a specific window class or type name that displays in the UI. Match capitalization in the user interface. Do not capitalize words such as field, tab, pane, button, list box, and window.

  • On the Groups tab, select an attribute that describes the group.

Do not capitalize window classes or window types when referred to in a non-specific sense.

  • confirmation message displays.

Copyright and Trademark Symbols

Always use the appropriate trademark symbol with product names on their first mention in the topic. Subsequent mentions do not require a trademark. For ACST trademarks, refer to the Product Marketing Guide. For other companies, check their websites for trademark information.

  • The exception to this rule is when the product is mentioned for the first time in a heading. In this case, do not include the trademark in the heading but use it the next time the product name is mentioned.

  • When referencing company or product names with punctuation or decorative elements, such as Guess? or E*TRADE, omit the punctuation and replace decorative elements with a hyphen for readability.

Build a diversified portfolio using E-TRADE. My sister purchased a pair of Guess jeans.

Copyrights and Trademarks

Frequently we reference products, both from ACS and other companies. Make sure to properly use the correct copyright or trademark symbol. The following is a reference list for some of our most referenced areas:

ACST Products

USPS

Microsoft Products

Apple Products

Use of Adobe Icons (including PDF icon)

Other Products

Adobe® Acrobat® Reader®

Dymo®

Facebook – no symbol required

iPod®

OnDemand™

Pew Research Center – nothing

PhoneTree® Print Shop®

Skype™

Twitter™

YouTube™

Visio™

Zebra®

Double Negatives

Do not use double negatives.

Wrong: You won't find no better solution than Realm software for seamless database management.

Right: You will not find a better solution than Realm software for seamless database management.

Future Tense

Replace with present tense when possible.

Problem: Click Add Minister, and the Minister dialog box will display.

Solution: Click Add Minister, and the Minister dialog box displays.

Gender

Use plurals or specific descriptions to avoid he, she, he or she, s/he, and it. See the example below.

Problem: The programmer writes code. He then compiles it.

Solution: The programmer writes code and then compiles it.

(or) Programmers write code. Then they compile it.

Indexing

Do not use initial capitalization except for proper names.

Use singular for nouns.

Collapse similar entries with secondary entries

Problem: planting bulbs planting shrubs planting trees

Solution: planting bulbs, shrubs, trees

Italic Type

There are some cases where italic type may be acceptable to use for emphasis. However,

  • Do not use italic type for UI elements.

  • Do not overuse italic type.

To align labels properly, insert the front of the document facing the back of the printer tray.

Modifier Placement - Only

In using only as a modifier, it should be placed directly before the word or clause to be modified.

Only e-file tax forms associated with the current tax year.
E-file only tax forms associated with the current tax year.

Noun Strings

Avoid noun strings. If you have one, hyphenate the words that are used as adjectives to aid comprehension. See also Hyphen.

Note: Never use a hyphen after an adverb ending in -ly.
UNIX-based workstation, end-user access, newly acquired software.

Passive Voice

Use active voice to convey your message clearly and concisely, avoiding the unnecessary complexity of passive voice. Active voice makes it clear who is performing the action.

Passive: Tax forms were electronically filed by our office.

Active: Our office filed tax forms electronically.

Split infinitive

Avoid split infinitives, but do not mutilate your sentence to remove a split infinitive.

Problem: To immediately navigate to the main menu, click Return.

Solution: To navigate immediately to the main menu, click Return.

Time Standards

Use a colon (without space before or after) to separate hours from minutes.

  • Example: 4:35

For time "on the hour," zeros aren't needed to denote minutes...

  • Example: The time range is between 8 AM and 5:30 PM

...unless AM or PM is omitted.

  • Example: The store closes everyday at 6:00.

Don't use AM or PM unless figures are used.

  • Problem: The meeting was this AM.

  • Solution: The meeting was this morning.

User Input

User input should be wrapped in the element <userinput>input text here</userinput>. Do not use quotation marks.

Note: Our CSS interprets XML elements and attributes, managing all formatting tasks.

When not using DITA XML tools, use Courier font to highlight what the user needs to type. Do not use quotation marks.

Example: To start the IOT server, type the following command:

RUNiot_Server

Wordiness

Always seek to simplify your sentence structure.

VerboseBetter
in the majority of instancesusually
in the event ofif
with a view ofto
up to this timepreviously