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.

Sign up for GitHub

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

Jump to bottom

Update rule description #42

Merged
merged 5 commits into from
Feb 8, 2017
Merged

Update rule description #42

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
53526e2
updates to rule description
cpandhi Jan 10, 2017
c3a33c0
Minor changes to the updated rule description
cpandhi Jan 10, 2017
8b1d691
Mades updates based on Mary Jo's comments
cpandhi Jan 18, 2017
f308f04
Update act-framework.bs
cpandhi Feb 3, 2017
a718317
Update act-framework.bs
cpandhi Feb 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions act-framework.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ Rule Description {#structure-description}

Each ACT Rule MUST have a description that:

* Is in plain language;
* Explains the accessibility requirement being tested;
* Lists any limitations and assumptions for the test;
* Explains the failure conditions and their reasons.
* Is in plain language and provides a brief description of what the rule does.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"a rule must have a description that provides a brief description of what the rule does" sounds a bit tautological 😉.
I'd suggest "provides a summary" or "provides a short explanation" instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like short explanation, will make the change.

* Explains the accessibility requirement being tested such as the WCAG SC or the technique the rule maps to; For example WCAG 2.0 Technique H67.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I recall correctly, a rule always applies to at least one success criterion, and may map to any number of techniques? If so, should this be separated into two points:

  • Lists the accessibility requirement being tested, such as the WCAG Success Criterion
  • Refers to any related information, such as the WCAG Techniques it maps to

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point Shadi, i will make the suggested changes. Thx.

* Lists any limitations and assumptions for the test, the test environment, technologies being used or the subject being tested; For example: A rule for 1.4.1: Use of Color has to make an assumption that CSS properties are used to make a link visually evident. Typical examples are: background, border, color, font, or text decoration.
* Provides the scope or the context of the rule;
* Explains the failure conditions and their reasons. For example the rule triggers on all images on the page that has no alt attribute defined.
Copy link
Member

@rdeltour rdeltour Jan 24, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the rule triggers on all the images on the page that has no alt attribute defined

do it mean the rule is applied to all such images, or returns a fail to all such images? (in other words, is it an example of the rule scope and context, or of the rule failure condition?)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This duplicates much of the Rule Outline. The Rule Description should be part of the Rule Outline and in plain language describe what the rule does..



ACT Input Data {#input}
Expand Down