Onboard Content Managers
Collaborate with your content team to build an amazing website.
At its core, Prismic is an interface for collaboration between developers and content managers. Developers get a powerful API for web development, and content managers get an intuitive simple app for publishing web pages.
If you’re building a website with Prismic, your content management team will probably have no issues learning the interface. But there are a few things you can do to make sure the hand-off goes smoothly.
Design your user experience
Prismic offers a user interface for content managers, but as a developer, you control the user experience. Think about how to model your website content so that management will be intuitive and convenient.
Here are some tips:
- Use tabs to organize content. Internally at Prismic, we often have an “SEO” tab to keep things tidy.
- Use Slices and Slice screenshots. (Screenshots are only available with Slice Machine.) Content managers tell us they love composing web pages with Slices, and screenshots show them exactly what each Slice will look like.
- Use Slice Variations to give editors the freedom to change a Slice’s layout or fields. (Variations are only available with Slice Machine.)
- Write human-readable display names. Your Custom Types, Slices, and Fields should have concise, informative names. Avoid names like “h2HexCode,” opting instead for a name like “Font Color.”
- Give a helpful example in your placeholder text. Your placeholder text should be a prompt, like “Select a category.” Don’t use this text for instructions, as it will disappear when the field is filled in.
- Seek a balance between freedom and simplicity for content managers. For example, instead of using a Color field, you might provide a Select field with a predefined list of on-brand colors.
- Use Content Relationships for common structures, like authors and categories, but avoid creating confusion by over-using them. For example, consider whether you could use a Slice instead of a Content Relationship. When you do use Content Relationships, consider using Collections to declutter the Document List.
Previews allow content managers to see what their content will look like before they hit Publish. Make sure your website has Previews configured and working properly. Then, explain Previews and Shareable Previews to your content team and encourage them to preview every change before they publish it. This is the best way to avoid design problems and help your team understand how editing works in Prismic.
Do a walk-through
Do a walk-through of the Prismic interface with your content team. Be sure to cover the essentials:
- Finding a Document in the Document list
- Editing a Document’s fields
- Managing Images
- Adding Slices to a Document
- All of the available Slices
- How to request a new Slice from your dev team
- Saving a Document
- Previewing a Document
- Creating a Shareable Preview
- Creating a Release
- Adding a Document to a Release
- Linking to Documents in a Release
- Previewing a Release
- Translating a Document
- Archiving a Document
- Browsing Document history
Also explain any general web development concepts that might be unclear, such as alt text and SEO.
Give users appropriate roles
All Administrators on your repository can see your technical settings like webhooks, API keys, and locales. Most users will never need to access these settings, so you can assign them the role of Writer or Publisher.
If users must have Administrator permission, tell them what settings they can access and what settings they should avoid.
On enterprise plans, you can also assign roles by locale. This helps users to focus on the Documents that are relevant to them, avoiding information overload and improving security.
Share useful resources
Share these resources with your team:
If your Custom Types have any unique features, like a custom tagging system or advanced metadata, create documentation in Google Docs or Notion and share it with the team.
Was this article helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum or using the feedback form above.