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

Rule outline #43

Merged
merged 3 commits into from
Feb 7, 2017
Merged

Rule outline #43

merged 3 commits into from
Feb 7, 2017

Conversation

moekraft
Copy link
Collaborator

This update provides a proposal for the Rule outline.

Trying not to be too prescriptive here but are we inherently being prescriptive by generating a rule outline?

Moe

act-framework.bs Outdated
@@ -35,7 +35,13 @@ ACT Rule Structure {#structure}
Rule Outline {#structure-outline}
-----------------------

Editor note: This sections gives a broad outline of parts make up an ACT Rule. We'll go into further detail in sections below. At this point it is important to show the reader the big picture
A rule MUST provide the following items written in plain language:
* A descriptive title
Copy link
Collaborator

Choose a reason for hiding this comment

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

Editorial: Leave a blank line between this paragraph and the list.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add, pass / fail criteria to the rule outline or do we expect that to be included in the test procedure.

Copy link
Member

Choose a reason for hiding this comment

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

@cpandhi good idea (as far as I can see): the possible outcomes may differ from one rule to another, so could very well belong to the rule description

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@Charu pass/fail criteria would be part of the test cases. I'm using Auto WCAG as the inspiration.

@moekraft moekraft mentioned this pull request Jan 23, 2017
act-framework.bs Outdated
* A descriptive title
* A unique identifier
* A rule description
* Associated criteria, standard(s) or requirement(s) (Note: Auto-WCAG calls this Background)
Copy link
Member

Choose a reason for hiding this comment

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

the item above (associated criteria, etc) describe the rationale for the rule.
Another aspect are pointers to remediation techniques (for instance to WCAG Techniques), would that belong to another item?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@rdeltour Correct. I think the techniques should fall under the test cases.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@rdeltour During the meeting it was agreed to shorten Associated criteria, standards or requirements to simply Accessibility requirement(s) and to add an item for Related techniques.

Updates based upon feedback from review on Jan. 25, 2017
@moekraft moekraft merged commit 64118bd into w3c:master Feb 7, 2017
@moekraft moekraft added closed and removed Reviewed labels Feb 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants