Skip to content

Latest commit

 

History

History
107 lines (59 loc) · 5.08 KB

06-web-elements.html.md

File metadata and controls

107 lines (59 loc) · 5.08 KB
title layout
Web Elements
article

Every piece of content we publish is supported by a number of smaller pieces. This section lays out our style in regards to these web elements, and explains our approach to the tricky art of SEO.

Guidelines

Alt text

Alt text is a way to label images, and it's especially important for people who can’t see the images on our website. Alt text should describe the image in a brief sentence or two.

For more on how and why we use alt text, read the Accessibility section.

Buttons

Button copy should always include verbs. Keep things clear and concise, and use sentence case. It’s OK to use an ampersand in button copy.

Standard website buttons include:

  • Log in
  • Sign up free
  • Subscribe
  • Email us

Checkboxes

Use sentence case for checkboxes.

Drop-down menus

Use title case for menu names and sentence case for menu items.

Forms

Form titles should clearly and quickly explain the purpose of the form.

Use title case for form titles and sentence case for form fields.

Keep forms as short as possible.

Only request information that we need and intend to use. Don’t ask for information that could be considered private or personal, including gender. If you need to ask for gender, provide a field the user can fill in on their own, not a drop-down menu.

Headings and subheadings

Headings and subheadings organize content for readers. They should include the most relevant keywords and cover/highlight the main point(s) of the page.

Headings and subheadings are written in sentence case. Avoid using end punctuation except for question marks or when a heading is two or more sentences.

Organize headings and subheadings hierarchically, with headings first, followed by subheadings in order.. (An H2 will nestle under H1, an H3 under H2, and on down.)

  • Headings (H1) give people a taste of what they’re about to read. Use them for page and blog titles.
  • Subheadings (H2, H3, etc.) break articles into smaller, more specific sections. They give readers avenues into your content and make it more scannable.

Links

Provide a link whenever you’re referring to something on an external website. Use links to point users to relevant content and trusted external resources.

Don’t include preceding articles (a, an, the, our) when you link text. For example:

If a link comes at the end of a sentence or before a comma, don’t link the punctuation mark.

Don’t say things like “Click here!” or “Click for more information” or “Read this.” Write the sentence as you normally would, and link relevant keywords.

Links should look different than regular copy, strong text, or emphasis text. They should have a hover state that communicates they’re interactive, and should have a distinct active and visited state. When setting the hover state of links, be sure to include focus state as well, to help readers using assistive technologies and touch devices.

Lists

Use lists to present steps, groups, or sets of information. Give context for the list with a brief introduction. Number lists when the order is important, like when you’re describing steps of a process. Don’t use numbers when the list’s order doesn’t matter.

If one of the list items is a complete sentence, use proper punctuation and capitalization on all of the items. If list items are not complete sentences, don’t use punctuation, but do capitalize the first word of each item.

Navigation

Use title case for main or global navigation. Use sentence case for subnavigation.

Navigation links should be clear and concise.

Radio Buttons

Use title case for headings and sentence case for button fields.

Related articles

Sometimes a long piece of copy lends itself to a list of related links at the end. Don’t go overboard—4 is usually plenty.

Related articles should appear in a logical order, following the step down/step up rule: The first article should be a step down in complexity from the current article. The second one should be a step up in complexity to a more advanced article.

If you can, avoid repeating links from the body text in related articles.

Titles

Titles organize pages and guide readers. A title appears at the beginning of a page or section and briefly describes the content that follows. Titles also tell search engines what a page is about, and show up in search results.

Titles are written (you guessed it) in title case. Don’t use end punctuation in a title unless the title is a question.

SEO

We write for humans, not machines. We don't use gross SEO techniques like keyword stuffing to bump search results. But we also want to make it easy for people and search engines to find and share our content. Here are some not-icky ways to do this:

  • Organize your page around one topic. Use clear, descriptive terms in titles and headings that relate to the topic at hand.
  • Use descriptive headings to structure your page and highlight important information.
  • Give every image descriptive alt text.