Skip to main content

Using Annotation Templates

Learn how to create and use annotation templates to quickly add consistent documentation across your projects

Who can use this feature?

Team, Advanced, Organization, or Enterprise plans

  • Only members with an Editor or higher role.

Annotation Templates help your team standardize annotations by providing reusable content for frequently documented items. Instead of starting from a blank annotation every time, you can choose a template and fill in the relevant details.

Templates are available for all annotation types, including built-in and custom annotation types.

Built-in accessibility templates

Zeplin includes a set of built-in accessibility annotation templates to help you document accessibility requirements more consistently.

The built-in templates cover common accessibility elements, including:

  • Heading

  • Image

  • Icon

  • Button

  • Link

  • Form field

  • Dialog

  • Landmark

  • Live region

When adding an accessibility annotation, simply select one of the built-in templates. The template provides a predefined structure. Just replace the placeholder values with the details for your screen.

If your team follows additional accessibility guidelines, you can edit the built-in templates or create your own.

Creating a template

You can create annotation templates for any annotation type, including:

  • Accessibility

  • Requirement

  • Behavior

  • API

  • Custom annotation types

To create a template, add a new annotation or edit an existing one, then click Add template. From there, select Create new template, give your template a name, add the content you'd like to reuse, and save it.

The next time you create an annotation of the same type, you'll be able to select your template instead of starting from scratch.

Managing templates

Annotation templates are managed at the workspace level. Users with the Editor role or above can create and edit templates. Any template you save will be available to all workspace members.

You can also edit or delete existing templates at any time.


Related articles

Did this answer your question?