Mobile Technique Template
From Mobile Accessibility Task Force
These are detailed instructions for writing mobile techniques. Instructions are highlighted.
Technique Status Category
Include links to discussions, previous drafts, surveys, meeting minutes, or production status as appropriate. Add status updates to the bullet list to help with an at-a-glance audit trail.
- NEW TECHNIQUE WRITTEN BY YOUR NAME
- @@ Link to survey when surveyed by group
- @@ Notes on work still needed before the technique is ready to publish, such as user agent support notes, etc.
Include information on when it is technically appropriate to use the technique, e.g. table with cell headers; smartphone with zoom feature; form fields with large blocks of text.
TECHNOLOGY CONTENT WITH RELEVANT FEATURES.
Include a list of success criteria, conformance requirements or guidelines to which this technique relates. For each one, provide:
- the anchor for that item. Copy the anchor from the success criterion URI address;
- the number of the item;
- the short name for the item;
- whether the technique is sufficient, advisory, or a failure of the item.
It is not necessary to provide a live link to the guidelines, but if you do, double-check that the link points to the correct place. It is also not necessary to provide redundant links to the Understanding and How to Meet documents; those are done automatically by the generator later in the process. The suggested format for these references is in the sample item below.
- text-equiv-all: SC 1.1.1 Non-text Content (sufficient)
User Agent and Assistive Technology Support Notes
Provide notes regarding known lack of support for this technique with particular user agents or assistive technologies.
Main text of the technique. Techniques begin with "The objective of this technique is to..." and describe what the user should accomplish, then move on to how. Some techniques are best explained through examples, but an overview of the approach should still be provided in the description.
THE OBJECTIVE OF THIS TECHNIQUE IS TO...
Examples for the technique, or links to external examples. Provide a description of the example, and source code if applicable. Explanatory content can be intermixed with code samples. <blockquote style="background-color:#FFFFCC;"If you are providing multiple examples, there are two approaches:
- Simple examples can just be provided in a bulleted list.
- More elaborate examples should have sub-headers for each example.
Provide a descriptive title for the header but do not number them, this is done later in the process. Use the samples in this template for each example.
You can include links to working examples or upload examples (see "upload file" link under tools navbar) to the wiki as needed.
Description of example.
Provide a list of links to external resources, if any.
Provide a list of related techniques. For techniques that are part of the published suite, a technique id (ex. H30) is sufficient. For techniques that exist only in the wiki, link to the wiki page.
Describe how to test reliably that the technique has been applied, or that it has not been applied. If there is more than one type of test procedure, copy the entire section including the "Tests" header, and provide information about the type of test in this space before the "Procedure" header.
If there are any prerequisite tests, list passing them as a required first step in the procedure. Provide an ordered list of steps, with at least one step to check for a particular condition.
- STEP 1
- STEP 2
- CHECK THAT…
Indicate which step(s) from the test procedure must evaluate to true. For failure techniques, use wording like "If check #2 is false, then this failure condition applies and the content fails this success criterion."
- #3 IS TRUE
Provide test files here. Currently, techniques do not reference test files, but we may do something with them in the future. Note that working examples (including source code) do not go here, they should be referenced in the examples section.