Style Guide
Always use the exact capitalization/wording of the item (for example, use a “&” instead of “and” if that’s how the link appears).
Always identify by name the page that you want the user to interact with.
If you only use an image to show an important button or icon, always use the alt attribute to describe it in words.
When asking the user to find an element, describe the item in a way that would make sense even if you couldn’t see the page (e.g. “Delete the custom date range of 1700-1783 and select the Search button.”)
Make sure to also include relevant wording (like the label on the button) and not just describe the button / link, etc.
- More like: Click the My Account button in the top right corner of the page.
- Less like: Click the orange button in the top right corner of the page.
Headings should be short, sweet, and descriptive. Use title-case capitalization and write with active verbs:
- Use Truncation is better than Activity III
- Browse Images is better than Browsing Images in Database
- Find Related Collections is better than Identify Links to Related Collections
In tutorial questions, make search terms and keywords lowercase. Connectors should be all uppercase.
Use bold for:
- Links & tabs
- Buttons and icons
- Drop-down menu options
- Article names (also use quotes)
- Search terms
Use italics for:
- Database names
Use all-caps for:
- Boolean connectors
- Hints and notes