How to run a form audit

Owned by Nicole Lee
Last updated: Oct 25, 2022

Now you have completed building the form, there is a final check that we need to perform before launching. It covers multiple different areas, and we will walk through them individually.

Check your readability level

Go to https://hemingwayapp.com/ and paste in your form content to make sure it meets the Grade 5 readability level. Try to avoid passive voice, and shorten or split up the sentence to lower your content’s reading level. Also, double-check to make sure there are no typos in the form.

Write custom error messages

Make sure the default error message is not showing because it was not very helpful and instructive enough to guide the users on how to correct a mistake. Remember to write your own error message for every single field.

Write your message in Custom Error Message under the Validation tab.

 

Create machine-readable API names

Make sure to follow these rules while creating your API Property names:

  • Are the API names readable?

  • Do they make sense within the context

  • Are the API names not too long?

  • Are you using a consistent way to concatenate words?

  • Are there irregularities with capitalization?

  • Do they contain weird characters?

 

 

Set up conditional logic

A smart dynamic form can change based on how a user answers a question and be able to segment questions to different types of users by using conditional logic.

You may apply a simple logic on your own inside the editor panel under the Conditional tab, the conditional logic is based on the following rules:

  • Each field can hide by selecting False or display by selecting True on This component should Display.

  • The visibility is dependent on another component defined within the form

  • The logic is activated when the configured field contains the plaintext value defined in the settings

If you need help setting up Advanced conditions, please reach out to Digital Services.

 

 

Display your form using the appropriate layout

When you are dragging and dropping Pages template under Shared Resources from the sidebar, you may display as Form to view all stacking panels on a single page. Once you have completed building the form, always make sure to display as Wizard in order to display a paginated form on SF.gov.

 

 

Assign permission roles

We need to set appropriate permission roles in order to allow residents to fill out the form. Please follow the instructions to set it up properly.

Under the Permissions tab:

  • Set Everyone to Submit Form

  • Set Administrator, Authenticated, Anonymous to Read Own Submissions

 

Walk through, preview, and test your form

Under the Preview tab, you may start filling out your form and walking through each scenario to ensure all the conditional logics are applied accordingly. You may be able to catch errors at this point and allow yourself to go back to the form builder tool and make edits to correct the mistakes.