Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accessibility Enhancement as per WCAG2.0 standards for 'Clock Signal and Triggering' page #452

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

schezfaz
Copy link
Contributor

@schezfaz schezfaz commented Jul 18, 2020

Enhancement: Rendered the content on the Clock Signal and Triggering page more accessible by making its content structure a11y compliant as per WCAG2 standards.

Ref #80 (removed plagiarism as part of revamp)

Changes done as per a11y guidelines:

  • Gave the page URL a more meaningful link:
    The URL of a page conveys a lot of information and thus making the URL link for the page standardised in accordance to the page title is a better practise.

    • Changed the url from .../docs/clock.html to .../docs/ClockSignalAndTriggering.html
  • Represented all numbers as digits:
    It is easier for the reader to consume the sentence when numbers are represented as numbers and not spelt out.

    • Changed "Two types of triggering" to "2 types of triggering" and in similar applicable places
  • Used consistent, simplified tone and grammatical structure:
    Accessibility standards state that content should be written in a simplified manner. All similar content (such as information cited in a list, or similar examples) should have a consistent flow.

    • For example, standardarised the content structure for types of Edge triggering and Level triggering respectively.
  • Replaced bulleted lists with numbered lists
    Before:
    image
    After:
    image

  • Removed unnecessary bold/italic highlights and used them only when emphasis was required.
    eg. : Removed bold highlight on "logic high" as it does not need emphasis with reference to context
    image

  • Added titles wherever necessary, broke down bug paragraphs into segmented sentences:
    Before:
    image
    After:
    image

  • Added alt. text, title and labels to all images + reference images being displayed within text context. Alt. texts and titles help when screen is being used in reader mode, or when the internet/browser is slow and HTML takes time to render the images (in this case the alt. text will be displayed on the screen)
    Title + Alt. Text (on inspect element):
    image
    Label:
    image

  • Removed Plagiarism
    Before:
    image
    After:
    image

NOTE: Only used the accessibility guidelines revelant to the content type on this page. Other accessibility guidelines can also be incoorporated based on content criteria like presence of tables, videos (transcipts), etc. All of these guidelines can be compiled into a single reference style guide as part of GSOD2020.

Preview Link(s): https://deploy-preview-452--tender-ardinghelli-ebb79f.netlify.app/docs/clocksignalandtriggering

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Sample preview link added (add the link(s) for all the pages changed/updated from the checks tab after checks complete)
  • Tried Squashing the commits into one

@tachyons
Copy link
Member

Changing to new urls can be tricky as all the old links to this page will start showing 404

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants