How do you manage product documentation at scale? As your organization and product offerings grow, maintaining consistent, up-to-date product documentation becomes more challenging. You may have multiple resources for internal teams or customers where you need to publish the exact same information, but updating it everywhere it appears takes a lot of time — and time is expensive.
Snippets offer a great solution, helping you efficiently manage and distribute information across workspace documents, knowledge base articles, Aha! records, and more.
Snippets are available with an Aha! Knowledge Advanced subscription.
Overview
Snippets are blocks of content you can insert anywhere across Aha! documents and records. A snippet is just like a document and uses the Aha! text editor. But unlike documents, you can use a single snippet simultaneously in multiple places and within other documents. When you update a snippet, it will update automatically everywhere you added it.
Snippets can solve a variety of documentation challenges. Here are a few ways you can use snippets to share information broadly in a scalable way:
Create snippets for company boilerplate content. Then, insert them where you need to across any workspace. When boilerplate information changes, you only have to update the snippets.
If you have multiple products that share functionality, you can create snippets that detail the shared functionality. Then, insert the snippet into knowledge base articles where you need to — even if you have multiple knowledge bases.
Insert temporary callouts across your knowledge base to invite people to a webinar or announce a planned deprecation. Delete the snippet when it is no longer relevant.
Create a new snippet
Create a snippet and insert it into any workspace document or record description.
Navigate to Settings ⚙️ -> Workspace -> Knowledge -> Snippets. You will need to be a workspace owner to do this.
Click Add snippet.
Edit the snippet's title and description using the Aha! text editor toolbar to add formatting and styling. Your edits will save automatically.
Add a snippet to a document
You can add a snippet to any note or record description field in your Aha! account. You cannot add a snippet to another snippet.
Place your cursor where you want to add the snippet.
From the text editor toolbar, click the + More options menu and select Snippet.
Use the search bar to find the snippet you want to add. Hover over the snippet and click Insert to add it.
Edit a snippet
Navigate to Settings ⚙️ -> Workspace -> Knowledge -> Snippets to edit any snippet in your workspace. Hover over the snippet you want to update and click Edit.
To edit a snippet from a location where it is inserted, select the snippet and click the Pencil icon. The snippet will open at the right of your screen, where you can edit it.
Your edits will save as soon as you close or click outside of the snippet. Content will update everywhere the snippet is used.