-
Notifications
You must be signed in to change notification settings - Fork 133
Best practices for creating accessible content
nannanli edited this page Sep 28, 2021
·
1 revision
This page is for identifying best practices when developing our content, so that we can reduce our testing effort and ensure compliance for our documentation. Please add to this page as you run into items in your testing process that might help the rest of the community.
Provide alternative text for meaningful images and visual data
- Alt text for an image must match what is used in the UI (ex. icons).
- If you have an image of text (flow diagram, screen capture), then you MUST have a text equivalent. This text equivalent can be in the form of alt text, a long description, or text surrounding the image in the documentation.
- Doc readiness checklist
- Doc planning
- Doc maintainers
- What is the Pull Request process and how to submit a PR?
- Build and Archive Legacy Documentation
- How to check broken links
- How to build PDF
- How to add a new file to the site
- How to build the site
- How to prepare appendix for a new release
- How to embed videos in Zowe docs
- How to write what's new/release notes
- How to report documentation progress and status?
- How to author in Markdown?
- How to author content or a new release? What process to follow?