Digital text standards
Find guidance for digital text including headings, text formatting, numbers, alert banners, and user interface copy.
Document standards
Well-formatted documents help people understand and use them.
Document naming, format, size, and purpose
Label documents by file type and extension. The format is "File title (file extension)."
Examples:
- File title (PDF)
- File title (DOC)
- File title (DOCX)
- File title (XLS)
- File title (XLSX)
- File title (PPT)
To find the file extension type, right-click on the file name and select Properties. It will list file extension as part of Type of file on the General tab.
Include the file size for all documents and a comma after the file type.
List the size of the document only if it's at least 1 megabyte (MB). Round to the nearest MB. 1 MB = 1024 KB. Do not put spaces between the numeral and the MB.
Examples:
- File title (PDF, 6MB)
- File title (PDF, 11MB)
Put any description of the file after the title.
Example:
Yes: Strategic Plan 2050 executive summary (PDF, 1MB)
No: Executive summary Strategic Plan 2050 (PDF, 2MB)
Heading levels
Heading levels outline the hierarchy of the content. For full detail about heading levels, visit Heading levels.
Link standards
Useful links help people decide whether to click and visit a page or download a file. They also help people navigate among pages.
Anchor links
Effective anchor links help people navigate long scrolling content. But avoid using them as a workaround for content that is longer than needed.
Only use anchor links when:
- You have long content
- You organize the content into logical topics
- It will be easier for the user to navigate links rather than scroll
For help with anchor links, complete a request form (must have network access).
Inline links
Don't include periods as part of a link.
Correct: this is a link.
Incorrect: this is a link.
Link labels
Link text must describe where the link will take the user.
Link text should avoid vague and unclear labels like Read more and Click here.
Don't use the same link text for links that lead to different destinations.
For guidance on how to style a link visually, visit Link styling.
URLs
Standard (long) URLs
Useful URLs let people identify the page, screen, or file before they click on it. A consistent URL convention also supports the maintenance of our websites and applications.
All URLs for pages, screens and files must:
- Display in lowercase
- Use a hyphen to separate words (for example, /human-services/child-support)
- Contain no spaces (“%20”) or other special characters
- Leave off file extensions with no value (for example, use path/to/file instead of path/to/file.aspx)
Short URLs
Effective short URLs make it easier to read a link, by replacing some of the URL path:
- Before: hennepin.us/your-government/facilities/service-center-info
- After: hennepin.us/service-centers
They also help promote programs, services, and initiatives in print and digital channels.
Guidelines:
- Use no more than 3 words.
- Use simple words.
- Avoid abbreviations unless your audience understands them.
Requirements:
- Create short URLs that reflect the content of the page.
- Use hyphens to separate multiple words.
- Use lowercase letters.
- Avoid special characters.
- Avoid duplicating other short URLs.
- Avoid using a short URL for linking between hennepin.us pages or drawers.
- Use just one short URL per page.
- Use the website’s domain.
- Don't use a link shortening service for links that appear on websites or in applications, except for social media platforms.
Readability tools
Readability tools like Hemingway or Flesch-Kincaid can help catch readability issues that writers and editors miss. The tools flag content that’s hard to read or that has other readability issues.
Use readability tools with care since they don’t replace careful review by humans.
Search engine optimization
Good search practices make it easy for people to find our online content. Useful metadata and keywords support good search.
We should use keywords in the page title, URL, and headings. But avoid this where it would break the rules of grammar.
Required metadata
For the page title:
- Stay within a character limit of 50.
- Leave off the words Hennepin County unless it is critical.
For the meta description:
- Stay within a character limit of 156.
- Use a concise description of the page content.
Optional keyword metadata
Keywords affect internal site search only. They don't affect external search such as in Google, Bing, or Yahoo.
Guidance for keywords:
- Use words or phrases not found on the page itself (like common misspellings, abbreviations, and slang).
- Use up to six keywords separated by commas.
- If no helpful keywords exist, you can ignore the keyword field in Sitecore.
You can ignore these Sitecore fields:
- Audience
- Service area
- Content type
- Department
- Page owner email
Social media guidance
Social media channels allow for easy two-way communication between Hennepin County and residents.
Social media channel administrators should follow the social media policy and guidelines (must have network access).
New social media channels require:
- Submitting an intake request with the Communications department (must have network access)
- Approval by the director of the requesting department
- Approval by the Communications department
Text formatting
Consistent formatting helps people read and understand text. Special formatting can increase clarity.
Use special formatting with care, to call out critical words:
- Use bold to clarify key information, for example: Walk-ins are no longer available. You must make an appointment. For more information, visit Bold and italics.
- Use italics to call out a name, title, or label, such as: "When you arrive, push the Call button outside the main door."
Don't use these text formats:
- Underline
- Highlight
- Color other than the standard black text color
- All caps other than acronyms
Transcripts and subtitles for video and audio
For standards and guidance on transcripts and subtitles, visit Writing for accessibility.User interface copy
User interface copy (UI copy) is the small bit of text that describes an action a user can take.
Examples of UI copy:
- In buttons to execute an action: Submit, Finish, Pause, etc.
- For confirmation before a final decision: Do you want to delete (item)?
- In radio buttons to choose one option in a list: Monday, Wednesday, Friday
Keep UI copy short, clear, and meaningful:
- Use 2-4 words. But use more words if you need, to clarify the task.
- Lead with action words like Submit, Complete, or Accept.
- Avoid vague words like OK. State in a clear way what users will do by choosing the button.
- Don’t use verbs for common labels. For example, use Back, not Go back.
- Don’t use the words a, an, or the.
- Use common words. Limit the use of terms unique to the county.
- Use action words in a consistent way throughout the website or application.
Adapted from Nielsen Norman Group’s guidance on UI copy.