IEEE Web Presence Style Guide | Printer Friendly |
This guide defines the standards and conventions to be used when developing a site within the IEEE Web presence.
Table of contents
|
Click the topic of interest below to review related styles and standards. |
|
The importance of site standards Visiting an IEEE Web site is often the first interaction a person has with the IEEE. This could be a conference site, a society site, or the IEEE main site at www.ieee.org, among others. It is important that this interaction is a positive one as it becomes a reflection on the organization hosting the site as well as on IEEE. As an international standards developing organization, IEEE is compelled to present a Web presence that reflects adherence to a set of organizational guidelines as well as industry best practices. Additionally, the standards outlined in this guide should be followed for the following reasons.
IEEE Webmaster and Web Manager Responsibilities Every IEEE Webmaster or manager who creates or maintains a web site assumes personal responsibility for its accuracy, professionalism, and quality. IEEE Webmasters and managers shall continuously assure that their respective web sites:
Additionally, IEEE Webmasters and Web managers are required to announce any new Web sites by sending an announcement to the IEEE webmaster noting the URL as well as a brief explanation of purpose or content. When developing a new template or header for an IEEE Web site, the following guidelines should be followed:
The sample wireframe below illustrates many of the IEEE Web presence standards as they might be applied on a second level (not "home") page.
|
Understanding usability and user-centered content
Accessibility
|
As of 1998, under Section 508 of the U.S. Rehabilitation Act, U.S. federal agencies must give disabled employees and members of the public access to information that is comparable to the access available to others. IEEE also strives to maintain a Web presence in accordance with Section 508, so as not to interfere with an individual's ability to obtain and use IEEE information quickly and easily. You can assist with this process by:
Accessible sites offer significant advantages that go beyond access. For example, those with "text-only" options provide a faster downloading alternative and can facilitate transmission of web-based data to cell phones and personal digital assistants. More information about creating accessible Web content can be found at the Section 508 Web site. |
Creating a consistent look and feel
|
Consistency is the cornerstone of usability. As the user moves through a site, the visual treatment provides instant reassurance that they are in the desired location, and gives an overall impression of professionalism and reliability. Visual treatment applies not only to obvious elements like logos and navigation, but also to content elements, fonts, colors, and backgrounds. Both internal and external consistency should be considered.
The IEEE main site is currently being redesigned and a broader range of color will be utilized. This color palette can be referenced in the IEEE Visual Identity Guidelines (PDF, 3.11MB) document within the "Brand Basics: Color" section. Although additional colors may be used within site page templates, efforts to incorporate colors from or complementary to the IEEE color palette will create a more unified look and feel between the sites.top of page IEEE sites should utilize a font designed especially for screen such as Verdana, Trebuchet, or Georgia and should present text at a minimum of 10pt. The IEEE main site uses Verdana and use of this font is encouraged. |
Content (text and images)
|
Definition and types of content Content is a piece of information. Here are some examples of page elements that may individually or collectively be considered content:
Page elements which have content implications, but which will be addressed separately from content in this guide include:
Short pages, those containing one or two screens of text at most, work best for the first few levels of a Web 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 is needed, the following devices should be considered to make the content more easily readable and navigable.
Topics covered in this section include:
Writing for Web versus writing for print Writing for the Web is very different than writing for print. You cannot simply move your print documents onto Web pages. This would not be using the medium to its best advantage. Developing content for a Web site very often means writing new material. Web readers typically do not read a page from start to finish on the computer screen. Instead, they scan a site for relevant items and then print the information for later use. Generally speaking, word count of a written piece for the Web should be about half the word count used when writing for print. Printing versus reading online If your topic includes extensive information, dividing it into multiple pages may make it easier to read online. However, many people prefer to read lengthy or complicated texts offline. Multiple pages will make it harder for users to print your information. Therefore, if your content is likely to be printed, either present it as a single Web page or divide it into subdivisions. In either case, you should provide a link to a printable version. Considering user goals and language When describing something a user can do on the Web site, describe it in terms the user would use. The imperative voice (commanding) is attention-grabbing and helpful, so it should go at the front of a phrase, i.e., "Find XYZ here" "Subscribe to XYZ" "Place order." The user likes to feel like they are in control. Since users can enter a Web site at any page and move between pages as they chose, every page should be independent. Explain the topic of each page without making assumptions about the previous page seen by the user. Links to background or explanatory information help users who do not have the necessary knowledge to understand the page itself. The following tactics will help ensure that Web readers will maximize the information you are presenting to them.
Follow these guidelines when presenting your content in a list format.
Within each IEEE site, there should be a consistent tone that is professional and appropriate for the IEEE organization. As visitors move from page to page within the site they should not be aware that different areas of content have been developed by different individuals. Here are some guidelines and best practices all IEEE publishers should follow to provide a seamless experience and a consistent voice for site visitors.
Shared vocabulary and word styles This section is intended to provide the preferred usage and presentation of common words on the IEEE Web site. The following words should be presented as shown here.
The following words should be used to imply the meaning indicated here. visitors - unidentified users of the IEEE web site; the public ("users" should not appear in public-facing copy) Web site (or site) - a collection of pages with a common purpose, URL, and look and feel (i.e., IEEE Xplore) Web site section (or site section) - the top-level categories of the site ("tabs" is also acceptable; "portals" or "iportals" is non-standard and should not be used); care should be taken to not use this term in a manner that could be confused with Sections of the IEEE site subsection - internally, we use this term to refer to collection of pages grouped together within a section, however, when referring to these section in copy "section" is sufficient Web page - a collection of content presented at a single URL **This section will be expanded to include IEEE terminology** Avoid adding an apostrophe to the name IEEE, such as "IEEE's publication…" Instead use “... publication of IEEE.” Use “IEEE,” not the “Institute of Electrical and Electronics Engineers” or “the Institute.” Use “IEEE” not “we” or "our,” but only use IEEE when referring to an activity or policy of the overall organization. Use "IEEE" not "the IEEE" unless IEEE is acting as a brand name or adjective and the article would be required if IEEE were removed from the sentence (examples: IEEE is the world's leading technical professional association. The IEEE Web site is vast.). 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) International writing guidelines
Graphic elements on a page are an important part of a visitor's impression of the IEEE Web site and consequently of the IEEE brand. Graphics should only be added after careful consideration has determined that they align with the overall look of the Web site, and add value to the user experience. Usability testing has shown that clip-art and stock photography is not valued by many of our users, and should therefore be avoided in favor of "real" images that help to illustrate a point, or nothing at all. When using statistical data on your page, make sure the information is current and up-to-date. All statistical data should be accompanied by the source from which it was derived along with the date the data was compiled. Using content from someone else’s Web site without asking permission is considered copyright infringement even if the copied content does not display a copyright notice. In the U.S., practically everything considered a private work and created after 1 April 1989 is copyrighted and protected whether it has a notice or not. This also applies to pictures and graphics, as well as scanned pictures from magazines. Update pages regularly in order to keep information timely and accurate. Data such as statistics, numbers, and examples all need to be recent and up-to-date. If such information is outdated, your credibility, along with the credibility of your pages, suffers. Users will be less apt to trust any information they come across on a site if some of the information is found to be outdated. |
Effective Use of Graphics and Images
|
When to use graphics and images Images should be used sparingly to enhance the written content and add to the visual interest of the page. IEEE.org users like images that have an obvious purpose. Be tasteful and don't let images overwhelm the user.
There are a variety of software packages available to assist you in compressing your graphics for use on the Web including, Netmechanic Acceleration GIFBot and Macromedia Fireworks. GIFBot is a downloadable software that is available free on the Web at http://www.netmechanic.com/accelerate.htm and will compress both JPEGs and GIFs by up to 90%. The following online tutorials offer information on optimizing your graphics for the Web. http://www.webreference.com/dev/graphics/index.html http://www.webreference.com/dev/graphics/compress.html When meaningful images are used—which should always be the case—captions should be used to help the user understand the context, content, and source of the image. It is important to provide meaningful text substitutes for users who don't display images. For example, when picturing the medal of honor recipient, use "IEEE Medal of Honor recipient Jim Smith" instead of simply "man." Alt tags can be used to give both disabled and non-disabled users a higher confidence that what they are clicking on will bring them to their desired destination. The following guidelines should be adhered to when using the IEEE Master Brand on IEEE Web sites. *Effective 1 September 2008 - 31 December 2009 - IEEE is celebrating its 125th Anniversary in 2009. IEEE entities are being asked to help commemorate this accomplishment by using the 125th Anniversary Mark, in place of the IEEE Master Brand, on materials created for 2009. Please refer to the 125th Anniversary Mark Guidelines (PDF, 3 MB) for more details on how this mark should be used on IEEE Web sites.
|
Navigation & Linking Guidelines
|
Navigation presentation and naming conventions Consistency makes sites easier to use, because visitors don't have to learn new tricks as they move around. This is particularly important when planning navigation, as it is one of the first and most commonly used tools on any page of a Web site. Please follow these guidelines.
When the user must scroll in order to view all page content and/or content "below the fold" is not obvious from the page title, anchor links should be used to inform the user of all content topics included within the page. The table of contents at the top of this Style Guide is an example of how anchor links can be used to improve usability. Basic navigation and link naming conventions apply to anchor links. When anchor links are used, "back" options should also be provided at the bottom of each topic. Breadcrumb navigation on internal site pages provides additional orientation to users. A breadcrumb trail is a special kind of navigation bar, featuring a hierarchical row of links. As the user moves deeper into the site, the breadcrumb trail should show the closest direct path back to the home page.
|
Creating Web pages
|
Unlike the names of files on your personal computer, the names of your Web page files are not purely for your own reference. The names help users understand where they are within the Web site, and to navigate back to particular content. The following guidelines should be used:
Short pages, those containing one or two screens of text at most, work best for the first few levels of a Web 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:
Landing pages are the "home" or "index" pages within a Web site section. There is only one landing page for each section. Generally speaking, short pages containing one or two screens of text at most, work best for the first few levels of a Web site where users are scanning for link choices. Landing pages should serve as an overview for the section and may also introduce the newest information added or changes to the site section. Place images and text on pages in a way that creates a clear visual hierarchy in order to :
The IEEE Web site uses left alignment for headings, sub-headings and text. Centered text prevents the user from quickly scanning down a single column on a page. To follow are some ways to show importance or priority.
To follow are some ways to show relationships between content.
Other tips for creating a more readable, interesting page layout include:
Lines of text should be no longer than half the width of the screen for optimum readability. Follow these guidelines when designing an interactive user experience:
|


