All articles in the ITS Knowledge Base will follow a consistent style and tone. This style guide is intended to provide a set of standards for content and formatting that should be applied to all articles. Please visit Creating Articles for descriptions of the types of articles that will be written in this knowledge base. This style guide pertains to all types of articles.
...
When you are instructing the reader to perform an action, such as clicking or entering, you should bold the word that corresponds to the on-screen buttons/clickable elements.
EXAMPLE 1: Click Save My Information to continue to the next screen.
EXAMPLE 2: Enter a personal email address (not your @uconn.edu) in the "Secondary Email Address" field, and click Save Changes.
2.2 – Quotation Marks
When instructing a reader to look for text on their screen, use quotation marks around the words they should be looking for.
EXAMPLE 1: Quotation marks should not be used when looking for text within a button/clickable element (see "Bold Words" above).
EXAMPLE 2: Un-check the box next to "Show Labels for Each Page."
...
- Highlight the text.
- In the toolbar, click the dropdown menu that by default says "Paragraph."
You can choose to add headings as you see fit. Ensure that the heading style is appropriate for the level of your heading.
Note title Note All headings, regardless of which type of heading they are (Heading 1, Heading 2, Heading 3, etc.) should follow standard capitalization practices for titles such that the major words in the title are capitalized.
For example, a heading should read "Helpful Functionalities of the Confluence Editing Window" instead of "Helpful functionalities of the confluence editing window."
2.4 – Numbers and Bullets
...
| Category | Correct Term or Phrase | Do not use | Notes |
|---|---|---|---|
| UConn Terms | UConn | UCONN, Uconn, uconn | |
| NetID | netid, Netid, netID | use "NetID" for all instances, including within emails: NetID#####@uconn.edu | |
| ITS Help Center, Help Technology Support Center | Husky Tech, Help Desk, Service Desk | ||
| ITS | UITS | ||
| Outlook | Office 365 Web Access | Office 365 Online | When referring to outlook and its services – "Office 365 Web Access" and the " Outlook Desktop Client" are two different ways to access the same service called "Outlook." |
| Outlook Desktop Client | |||
| Giving Examples | (i.e., ________), or (e.g., _______) | (example, ____) | |
| In article titles when referring to things that happen in outlook or windows | "on Windows" "on Mac" | "in Windows/Mac" "for Windows/Mac" |
...
Instead of using a layout table for information, consider using the Columns macro. When screen reader users encounter a table with data cells coded using <td>, they expect to also hear information about table headers (<th>). Layout tables do not have table headers. Typically, in HTML, a layout table could be assigned the role="presentation" so that screen readers will read the content of layout tables as text, rather than as a table; this is not possible through Confluence. Because this is not a function Confluence supports, it is better to use the Columns macro to visually style the page. When using the Columns macro, you will be asked to input the column width in pixels or in percentages. Use percentages so that the column content will be responsive. Add additional Columns by inserting additional macros below the initial macro.
4.6 - Color Contrast
Making text high enough contrast against its background is vital for users who are colorblind or may have low vision. These users may not be able to distinguish text if it is too similar in brightness to its background. One good tool to check for color contrast is the Colour Contrast Analyser. To download Colour Contrast Analyser, click the Download button and choose CCA-Setup-3.0.1.exe. Text should meet a ratio of 4.5:1 between the foreground and background colors. This will cause the WCAG 2.1 results heading 1.4.3 Contrast (Minimum) (AA) to have green check marks. If the results show a red x, then the contrast is not high enough and you will need to adjust the text or the background's color.
...