Text instructions are adequate to help the user complete the step. The "Create repository" button is visually prominent through size, color, and placement. The following screenshots do not meet our criteria for inclusion. Screenshots that do not meet the criteria The screenshot is helpful to find the correct option. There are three elements that could be interpreted as "settings" on the main page for a repository: the "Settings" tab, the gear icon in the "About" section of the right sidebar, and the account settings accessed via the profile picture. The interface has multiple choices that can cause confusion The screenshot is helpful to locate the correct option in the menu, which is not visible until the dropdown is opened. Options to clone a gist are contained under a dropdown menu labeled "Embed." The UI element is not immediately visible The screenshot also gives a visual reference for the aspect ratio required. It may be hard to find among the other repository settings. The edit button for a repository's social media preview image is small and visually unobtrusive. The UI element is small or visually subtle The following screenshots do meet our criteria for inclusion. To help you determine whether to add a specific screenshot, consider the following examples of screenshots that do and do not meet our criteria for inclusion. The interface has multiple competing choices that can cause confusion.ĭo not use screenshots for procedural steps where text alone is clear, or to show code commands or outputs.For example, the element is contained in a dropdown menu. The element is not immediately visible.The element is small or visually subtle.Use a screenshot to complement text instructions when an element of the user interface (UI) is hard to find: Therefore, we only add screenshots to GitHub Docs when they they meet our criteria for inclusion. When captured at different pixel dimensions and degrees of zoom than the reader is using, screenshots can be confusing. On the other hand, screenshots privilege sighted users, add length and load time to articles, and increase the volume of content that needs to be maintained. When supplied with alt text, screenshots help blind and low-vision users collaborate with sighted colleagues. Screenshots make articles more visually scannable and make instructions easier to understand, especially for people who have difficulty reading. There are positives and negatives to adding a screenshot.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |