Content Types and Formatting
- James Powell (Deactivated)
Owned by James Powell (Deactivated)
Inserting images, dynamic content, video, informational notes, and linking to other pages appropriately helps create documents which are user-friendly and accessible to those leveraging screen readers and other assistive technologies. Formatting of text and different content types can impact the usability of documents as well. The pages that follow will lay out how different content types and formatting option should be leveraged whilst creating documents.
Design Guidelines
- In and effort to create documentation that is easy to navigate be sure to appropriately leverage headings.
- To ensure documentation that allows for screen readers and other assistive technologies to assist the end user, always input alt-text for every image inserted into a document.
- Any link to another page must use descriptive link text and never use one word link texts.
- All embedded video must be captioned.
- Tables are intended only for structured data and all columns must be appropriately titled.
- Keep the default color schemes.
- Sequential steps should be represented as a Numbered List.