The following is a list of items to take into consideration while building out a Style Guide. Feel free to add notes or make comments on any of it.
...
Use this repository to create screenshots: https://userdocs.lyrtech.org/repositories ArchivesSpace User Docs test site
This is a test repository set up specifically for User Documentation. The purpose is to create standardized screenshots using real-world examples. These collections are from actual ArchivesSpace users so please be respectful of the data and don’t share it outside the scope of this team.
If you upload a new image that has the same title as an existing image, the new image will replace the existing image on the published page, even if you don’t publish your edits. To avoid this, append the date the screenshot was created to the file name (example: AccEdits_20210315)
Add alt text to images for accessibility.
If using the old editor, click on the image and select Properties to add alt text. If using the new editor, click on the image and select alt text.
If the image has a caption then alt text is not necessary.
Tips from Web Accessibility Evaluation Tool (WAVE):
“Alternative text should be succinct, yet descriptive of the content and function of an image. Lengthy alternative text (more than around 100 characters) often indicates that extraneous content or content that is not available to sighted users is being presented.”
“Ensure the alternative text is succinct, yet descriptive. Ensure that no content is being presented in the alternative text that is not available to sighted users viewing the image. When possible, either shorten the alternative text or provide the text alternative via another method (e.g., in text near the image, through a separate description page, etc.).”
Do not use quotation marks(“ “) or brackets [ ] in the alt text field as they are not supported in Confluence.
If using the alt text to communicate the full message in a screenshot then it is ok for it to be longer than 100 characters. ( Merge message, The resource [resource name] will have the select records merged into it. All select records will be deleted and any linked records will be re-linked to this resource.).
Where to place screenshots
Place the screenshot after the text describing it.
Immediately following the descriptive text? i.e. if we do step-by-step instructions would we want a screenshot for each step?
Use borderlines around the image to make it more visible. (Note, borderlines are not available in the new Confluence editor, there have been complaints so it may be added at a future date.)
If using the new editor, adding a caption can help delineate the image.
When making a screenshot, try to crop so that there is enough context for the user, but do not make it so large that it will be difficult to read.
...
Save the page to be versioned as a child of the current page. The child page will serve as instructions for users operating older versions of ArchivesSpace.
Append the title of the child page with the version number of the last relevant version. Use this format: (version x.x.x)
Add the following text under the title of the child page: Note: These instructions apply to an earlier release of ArchivesSpace. Please view the Table of Contents to access instructions for the current release. For information about the most current ArchivesSpace release, please visit: https://github.com/archivesspace/archivesspace/releases/latest
Append the title of the parent page with the first version the instructions refer to. Use this format: (from vx.x.x)
Make your edits to the parent page
For an example of a versioned page, see /wiki/spaces/ArchivesSpaceUserManual/pages/1818329113
...