Tag Archives: documention

Rian Rietveld 3:18 pm on August 3, 2017
Tags: , documention   

WPa11y documentation meeting

Attending: @travel_girl, @samikeijonen, @sergeybiryukov and @rianrietveld

Goal of the meeting:

Kickoff meeting for rewriting and reorganising the documentation on WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ regarding web accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility).
We want the documentation set up so that it’s complete, without duplicates, easy to find and put it on places where people actually will read it.

What we agreed on:

  • We will start with our own handbook
  • In the topic spreadsheet we gather topics and assign ourself to write about them
  • We will add topics as we go
  • We will write in Google Docs (Sami opened a directory for this)
  • We can organise the topic later in a logical way before publishing them in the accessibility handbook
  • We report and discuss our work every Thursday in the #accessibility SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel
  • The goal is to write one topic a week per person
  • When the topics are added to the handbook, we will review the current documentation on wp.org to see where we can ask the teams to replace/add/modify text to prevent double info and to link to better information.

For the topics we want to keep a template, for example:

  • Topic
  • Short intro with:
    • Good Practice
    • Bad Practice
    • Why
    • Exceptions
  • Examples
  • Resources with links

We don’t want to copy all the info there already is on the web, but point to good info and examples.

If more people want to join in, you are most welcome.

#documention

Barrett Golding 2:28 pm on February 6, 2016
Tags: documention,   

Accessibility Quick Start Guide in draft: needs vetting

The WordPress AccessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) Handbook now has a draft of a Quick Start Guide. The doc needs edits, comments, and vetting.

We intend this as a resource for developers to quickly grab WordPress-oriented code examples and a11yAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) guidelines. Let’s make sure everything is accurate and clearly explained, and that nothing a11y-critical for WP dev is missing. (This process might also help us identify which topics need further explanations in other Handbook sections.)

Please review the draft and leave your comments on this post.

#documention, #handbook

Barrett Golding 9:12 pm on December 28, 2015
Tags: documention,   

WP a11y docs list

Here’s a collection of all the A11yAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) resources I’ve found at WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ sites (and two Google docs in use for drafting Handbook pages):

Make WordPress Accessible blog
https://make.wordpress.org/accessibility/

Make WordPress Accessible> AccessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) Handbook
https://make.wordpress.org/accessibility/handbook/

(Draft: outline for A11y Handbook) Accessibility Contributor Handbook
https://docs.google.com/spreadsheets/d/1tOYzFn9vc7Ff4yGBmDajelrl7XMDUz4PR5H2lB4exI4/edit?usp=sharing

Make WordPress Accessible> Useful Tools

Useful Tools

WordPress Accessibility> Theme Patterns
https://github.com/wpaccessibility/a11ythemepatterns

Docs Handbook> Handbooks Style and Formatting Guide> Accessibility

Handbooks Style and Formatting Guide

Codex> Accessibility
https://codex.wordpress.org/Accessibility

Theme Handbook> Accessibility

Accessibility

Theme Review Handbook> Accessibility

Accessibility

Theme Review Handbook> Accessibility> #resources

Accessibility

Theme Review Handbook> Accessibility> Resources

Resources

Theme Directory> accessibility-ready tag
https://wordpress.org/themes/tags/accessibility-ready/

PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Directory> WP Accessibility

WP Accessibility

Plugin Directory> Access Monitor

Access Monitor

(Draft: guidelines for Plugins) WordPress A11y Code Standards
https://docs.google.com/document/d/1iySvDJ4duHYt6YlnnjnBNbU5LKAn1uRBMH8FKAfmswE/edit

Accessibility code standards for WordPress coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. (similar to above)

Accessibility code standards for WordPress core

#documention, #handbook

esmi 12:14 pm on March 8, 2013
Tags: documention,   

Accessibility for Theme Developers: First Draft Complete

I think I’ve finally finished! *gasp* Thank you to everyone who provided earlier feedback and jogged my memory.

Is there anything on the completed page I need to re-word or explain in more detail?

As previously, please post all feedback here rather than on the draft page itself.

#documention, #theme