Custom checks
Custom checks let your organization test rules Silktide does not ship out of the box: brand requirements, legal wording, technical conventions, or any other observable page condition you care about. Once created, a custom check behaves like any built-in check - its findings appear in the Inspector, can be decided on, and can become tasks.
Adding a custom check
Open any website, choose Settings in its sidebar, then under All sites choose Checks and select Add check. Choose the kind of check:
- Policy - one or more rules about a page, such as its title, its links, its images or its text, combined so a page has an issue when it matches every rule or any of them. If your organization also uses Silktide 4, it reports policies there too.
- Text match - words or phrases to find on your pages. Text matches are reported in Silktide 5 only.
Or press ⌘K (Ctrl+K on Windows or Linux) and run Add policy or Add custom check (a text match).
To change a check your organization made, select it in the same Checks list and it opens in its editor. Checks Silktide ships open their details instead. You can also ask the Agent to draft and test a check for you, but you never need it: everything the Agent can set on a check, you can set in the editor.
If you do not see Add check, ask an account administrator. Text matches need the same permission as managing priorities. Policies need permission to manage policies, which account administrators have.
Policies
A policy is a list of rules. Each rule looks for one thing on a page: words in its title, a link to a particular address, an image with particular alternative text, and so on. Choose whether a page has an issue when it matches every rule or any rule, and turn on Find pages that don't match for a rule that should flag pages where something is missing.
Each rule reads back as a sentence while you edit it, so you can check it says what you meant, and a rule with a mistake in it (such as a pattern that is not valid) shows what to fix before you can save. Each issue a policy finds names the rule that found it.
You also choose the policy's priority, whether its issues are errors or warnings, the text each issue shows, whether a page is reported once however many places on it match, and which websites it applies to.
Policies walks through the editor: each kind of rule, testing a policy before you save it, and every setting.
Text match checks
The most common custom check finds words or phrases on your pages and PDFs: a product name that was retired, wording legal asked you to remove, a competitor's trademark, a phrase your style guide bans.
When you create one, you choose:
- What to match - one or more words or phrases.
- How to match - whole words only, or anywhere in the text, and whether case matters.
- Where it applies - all websites, or only the sections you pick.
- Priority - the same priority levels as every other check, so it sorts honestly against the rest of your work.
The editor and tester
Custom checks are created and edited in a full-screen editor with a built-in tester: point it at one of your URLs and it runs the check against that live page, showing exactly what would be flagged and how the finding will look in the Inspector. The tester runs what is in the editor, saved or not. Test before you save - a check that matches too much creates noise, and one that matches nothing creates false confidence.
A new text match starts as Draft (don't run), so it finds nothing on your websites until you set its Status to a priority. A new policy starts at your account's default priority and runs from the next test of each website it applies to.
Making custom checks count
A custom check affects scores when it belongs to a criterion. Add it to an existing criterion, or create a criterion for your organization's own policy area - compliance baselines are a common home. A check that belongs to no criterion still reports findings; it just does not move a score.
Manage which checks run, including custom ones, from Website settings → Checks.
Related
- Policies - every kind of policy rule, and testing a policy before you save it
- Criteria - the scored areas checks belong to
- Checks - every check Silktide ships
- Compliance - where policy baselines are reported