Content is any piece of information found on a digital page, including text, images, multimedia, and page elements such as contact information (name, phone number, email address, etc.).
This page contains the style guide for creating, editing, and maintaining content.
When "IEEE" is part of the name of a product, publication, service, Society, or other title, it should never be dropped. This applies to first and subsequent references. (Examples: IEEE Xplore®, IEEE Spectrum, IEEE Computer Society).
|IEEE member||IEEE Member|
|Serial comma in 3+ series (e.g., "Red, yellow, and blue wires")||Regular comma in 3+ series (e.g., "Red, yellow and blue wires")|
|Colon or em dash where necessary. See Hyphens, en dashes, and em dashes section for usage||Regular dash. See Hyphens, en dashes, and em dashes section for usage|
|Third-person language for IEEE (see Tone and voice section)||First-person language (we, us, our) for IEEE|
|IEEE(see References to IEEE section)||The IEEE, the Institute of Electrical and Electronics Engineers, the Institute, etc.|
|Months in dates spelled out to avoid ambiguity (4 September 2015); do not abbreviate month if possible||Numerals (4/9/15 US or 9/4/15 international)|
|People with disabilities (use "people-first" language where the person is identified prior to the disability)||Disabled/handicapped|
|Numbered lists: use 1., 2., etc.||1) or (1)|
|Spacing around slashes: close up any spaces. Correct usage: and/or||Incorrect usage: and / or|
|website||Web site, web site, Website (unless the first word in sentence or in title)|
|Internet, intranet, extranet||internet, Intranet, Extranet|
|Testimonials: edit small grammatical mistakes||Testimonials with mistakes|
|Degrees: Use periods for abbreviated degrees rather than spelling out in full. For instance, use M.S. and Ph.D. Capitalize fields of study when referring to degrees only (e.g. Ph.D. in Electrical Engineering)||BS, MS, PhD in electrical engineering|
|Names on second reference: Use last name only on second reference (add title if source prefers)||First names on second reference|
|Memorandum of Understanding (MOU)||MoU|
|Ensure (unless referring to insurance)||Insure (unless referring to insurance)|
The purpose of the page should determine the length of the content.
Use short pages, or those containing one or two screens of text at most, for the first few levels of a site where users are scanning for link choices.
Longer pages (those that require more scrolling) may be more acceptable deeper within the site where related content can be printed and read later.
The primary measure of page length should be content. Think through your material; create logical divisions and subdivisions based on the structure of your information. You should not arbitrarily divide your information simply to conform to acceptable page length.
When creating deeper pages within the site, where scrolling may not be avoidable, the following devices should be considered to make the content more easily readable and navigable:
• Anchor links to bookmarks throughout the page with "back" links to return the user to "top"
• Subheadings and relevant links (where appropriate) to serve as signposts for the user
• Bulleted copy and meaningful graphics, or pull quotes, to break up larger blocks of text
• End links allowing the user to access other relevant pages without having to scroll back to the top of the page
Keeping accurate and timely content establishes credibility for IEEE as a trustworthy source of information.
Lines of text should be no longer than half the width of the screen for optimum readability.
Do not use content from another site (including IEEE digital sites) without permission. For example, do not use Google images found through search without permission of the owner.
Provide the source of all content that is not original once permission for publishing has been obtained. Or instead, link directly to the source.
Show importance or priority by:
Some ways to show relationships between content include:
Other tips for creating a more readable, interesting page layout include:
Content for the digital platform versus for print
Do not simply move print content onto your digital pages. Instead, write content that can be quickly and efficiently read by a user in the most concise manner possible.
Print versus online
If your content is likely to be read online, create shorter pages that are cross-linked.
If your content is likely to be printed from the digital platform, create one long page.
Consider audience and tasks
Determine your page’s potential audience members.
Establish the goals each of these audience members may want to achieve on your page, and create a page that helps users easily accomplish these goals.
Consider user language
All content for IEEE.org must be written in English.
Let the user know where he or she is on every page. Establish the topic by using a unique page heading.
Link to background information where necessary.
Use the following devices to increase scannability:
• Use shorter (50–80 characters per line) rather than longer line lengths (100 characters per line)
• Use left alignment for headings, sub-headings, and text
• Link where appropriate
• Use lists rather than paragraphs wherever possible
• Include only one main idea in each paragraph
• Put the most important information at the top
• Start the page with the conclusion as well as a short summary of the remaining content
• Use headings where applicable
• Never use capitalization (CAPS) for emphasis
• Use short, simple words that are to the point
• Be concise and focused
For longer pages, use the following tools to make the page easily scannable:
• Anchor links
• Subheadings and relevant links
• Bulleted copy - view how to format a bulleted list on IEEE.org (PDF, 70 KB)
• Meaningful graphics, or pull quotes, to break up larger blocks of text
• End links
Effective use of lists
Follow these guidelines when presenting your content in a list format:
• Use numbered lists when the order of entries is important.
• Use bulleted lists whenever the order of the entries is not important.
• Generally, limit the number of items in a single list to no more than nine.
• Generally, limit lists to no more than two levels: primary and secondary.
International writing conventions
Use the following formats:
|Phone numbers|| |
|Seasons||Use the month or quarter of the year to refer to dates, not the season. Do not capitalize seasons. |
|Time zone||Use local and UTC (e.g., 2:00 p.m. ET/1800 UTC-05). Use ET (Eastern Time) all year instead of EST or EDT. Use the same for CT (Central Time) and PT (Pacific Time). Use periods and lowercase letters in a.m. and p.m. |
|Currency||When referencing to US currency, include a “US” in front of the dollar sign (e.g., US$25). Do not include decimal point and cents if the number of cents is 0. |
|Humor and colloquialism||Avoid using puns, clichés, popular expressions, and jargon in your writing.|
When using a number between zero and ten, spell out the number (e.g., "three" or "ten").
When using any number higher than ten, use the numeric version (e.g., "12" or “300”).
The page titles of all IEEE digital pages should be in title case. All words four letters or more get capitalized, as do any nouns, pronouns, verbs, or adjectives. Any hyphenated word will require a capital letter after the hyphen in titles (for instance, Pre-University).
Section headers, form fields, and all other page content should be written in sentence case. Only proper nouns and titles should be capitalized.
Punctuation of the following commonly-used IEEE terms is as follows:
| || |
British spellings and terminology
Change all British spellings to American spellings where applicable. This includes "toward" (US) vs. "towards" (UK), "among" (US) vs. "amongst" (UK), etc.
Adhere to standard grammar and punctuation rules when it comes to pluralization of typical words.
The plural of calendar years does not take the apostrophe before the “s.” For example, the plural form of 1990 is 1990s.
Hyphens, en dashes, and em dashes
Use the hyphen to combine words and to separate numbers that are not inclusive.
Use the en dash to represent the words “to,” “through,” or “and.” Use it between page numbers, years, names, a range of values, or for opposites. When using the en dash to represent a range, if the word “from” occurs, the word “to” must be used rather than the en dash (e.g., “ranges from 11 to 50 times”).
Use the em dash to mark a suspension of the sentence, or like a parenthesis, to mark a subordinate thought within a sentence.
Words that are often confused
Be sure to use the correct and more accurate word in context.
At a minimum, all sites should include the following best practices for SEO:
Home page and top-level landing page metadata descriptions
Proper use of page titles throughout the site
The following guidelines should be used:
A web form is a web area where users can enter data that is sent to a server for processing. A web form resembles paper forms because users fill out the forms using check boxes, radio buttons, or text fields. A form could be used to collect many different types of data such as member, personal, and/or financial information.
Advertising on IEEE digital pages should be contextual to the site's purpose and should be used sparingly.
Advertising on IEEE.org is restricted, but it is allowed on other IEEE sites.
Contact the Digital Innovations team, firstname.lastname@example.org, with any questions regarding advertising issues on IEEE sites or advertising on IEEE.org.