Docs
A dedicated workspace to gather and share information.
Last updated
A dedicated workspace to gather and share information.
Last updated
Docs will serve as a dedicated workspace that allows you to collaborate on with your customers or internal team members. Docs provide transparency between you and your customer, the ability to create templates for consistency across team members, and the capability to share with customers to create a more collaborative relationship.
You can create Docs manually or automated via a playbook. Below we'll go over how to manually create a Project. If you want to start with a template, read below Docs: How to Create a Template.
You can create a Doc in a number of ways:
Via the Global Create New Button
In an Account or Organization 360
Via a Doc Table View
Apply branding and greater personalization settings to your content for Docs ! This will make Docs look and feel more like your brands and less like Vitally's, helping to maintain brand consistency in the experiences that you create for your customers.
There are three things you can do for Docs to use the branding feature:
Set a Brand Color in settings - this will be inherited into Docs and Surveys as the color for the primary CTA in the invitation emails. These can be changed at the Doc or Doc Template level.
Set a company logo using your organization or your customers' logo in Docs and Surveys. This is supported for Docs, Doc Templates, and Surveys.
Upload a custom banner image to your Docs. Access recent uploads to make the entire process smoother when you have many accounts to manage. This is supported for Docs, Doc Templates, and Surveys.
If you're setting up Docs Branding for the first time starting off with your Brand color is your first step. This setting will be used as the default color for calls-to-action in the invitation emails that are sent when a user is shared on a doc, or when they are sent the survey.
Setting the default color for Branding:
Navigate to your Settings (⚙️) by selecting your Account Logo on the top left
Select Account and Billing
Select Edit next to Brand Color and choose your default brand color
You can change the brand color within an individual Doc or Doc Template by selecting Branding on the top right. This button will not show up for customers when the Doc is shared with them.
After setting up your Brand Color, you can add a Banner Image for your Doc Templates. We'll keep the most recently uploaded images to make them a little easier to reference. You'll see recent images that anyone in your org has uploaded, not just you.
How to set up a banner image in a Doc or Doc Template:
Navigate to your Settings (⚙️) by selecting your Account Logo on the top left and under Vitally Objects select Docs then Doc Templates or go to an existing Doc
Select an existing Doc Template or doc, or create a new Doc Template or doc
Select the Branding button on the top right and select Add banner image
Upload your image or go to the recents tab to. We'll keep track of recently uploaded images from anyone in your org.
Images greater than 700px in width work best
If you hover over the banner image in a doc you can select Edit or Move.
If you Edit you can reset (i.e. clear) the image
If you select Move, you can move it vertically. We'll automatically fit it to the width.
Lastly, after setting up a Banner Image, you'll set your icon in your Doc Templates. You'll be able to select from 3 options in addition to the original emoji capability.
Use your company's logo
User your Account/Org's logo
Or upload a custom image
How to set up an icon in a Doc or Doc Template:
Navigate to your Settings (⚙️) by selecting your Account Logo on the top left and under Vitally Objects select Docs then Doc Templates or go to an existing Doc
Select an existing Doc Template or doc, or create a new Doc Template or doc
Select the Branding button on the top right and select change icon (or just select the actual icon!)
Choose an emoji or switch to the image tab to select your customer's logo (i.e use the Account's/Organization's logo), or upload a custom image.
Note the option to use your customers logo will be missing if it's a team doc.
The recommended size is 100x 100 pixels.
Q: Who can set up default branding? A: Only admins in can set up default branding. Anyone who can create a Doc can change the colors, icon, or banner for individual Docs.
Q: Can I change the to / reply to email? A: Not currently. The sender email / reply to email will be support@vitally.io
Q: How can I remove an image from the recent uploads? A: Currently you can not manage recent uploads therefore you can not delete images.
Q: I can't find one of the recent uploads? A: We only display the most recently 9 images, nothing more. It may the 10th image. You'll need to upload the image again.
Q: Can Team Docs be branded? A: Yes, however we do not have the icon setting to use a customer's Logo.
Creating a template first to then apply to a doc will be the best workflow. You can create a doc without a template and if that's all you're trying to do, scroll above to Docs: How to Create.
Only admins can create templates that are shareable with all team members.
Now that you've created your template and/or doc, you can start adding all the necessary information to start building out your shareable, informative doc. Above we went over some of the basic functionality but here we'll take a deeper dive into the commands, variables, and notifications.
Commands and Variables provide you the ability to format text and add important data points to share vital information being tracked in Vitally.
A backslash (/) is to add commands like heading, text, bulleted list, etc.
In the tabs below you'll find information on:
Embedding Media & Cards (images, files, etc)
Adding Sections to your Docs
Variables allow you to add important information from your Organization and/or Account level. You can even configure these to be editable by customers making this a collaborative space!
You can add comments or @ mention a team member/customer. This is another way to make this space collaborative and allows you to keep communication centralized. This will trigger a notification to be sent out via email and in-app.
You can embed individual Tasks into an Account (or Org) Doc or Team Doc. This is how you can assign a task to one of your Accounts (or Orgs)! When working with Tasks in a Doc there are 2 different pop-ups:. To learn how to embed Projects or Tasks scroll above to Docs Supported Functionality where you'll find a tab Embed Tasks and Projects.
You can embed individual Tasks into an Account (or Org) Doc or Team Doc. This is how you can assign a task to one of your Accounts (or Orgs)! When working with Tasks in a Doc there are 2 different pop-ups:
While you can embed a task that is for an Account (Or Org) in a Team Doc, you can not embed Team Tasks into a Doc for an Account (or Org).
Selecting the Task text will open a pop-up where you can toggle to show to external users, assign to an Account (or Org), provide a 'partner' (a CSM for example), and change the due date.
Selecting the expand arrows icon to the right of the task you'll get the traditional task slide out where you have more information to update like category, tags, blocked by/blocking, etc...
Let's dig into these both a bit more below.
Observers can not create new Tasks or Projects in a Doc
Docs are a great space to see who's working in a Doc, who's shared on the Doc, what information is visible to external users, and collaborate with your customers.
You can invite specific internal team members or customers to a Doc. Inviting users is easier than ever by being able to invite specific individuals or allowing anyone with a link to gain access to the Doc.
If a Doc is added to a Hub, anyone in that Hub will have access to that Doc.
You have two options on inviting users, whether internal team members or external users:
Users who access the Doc via a public link are considered "anonymous", and will not be able to comment or modify any of the data in the Doc.
Below we dig into both of these sharing methods more in depth:
You can view who is working on a Doc! If you and your team are all working in one Doc, you can all see who is in the doc and where they are.
You’ll be able to see the avatars of users looking at the same Doc in the top-right corner of the screen; hover over to get a full list of names. In addition, if any of your teammates are focused on a certain node of the document, you’ll see the same indicator to the left of that node. This only supports Vitally Users for now; not “External” Users (your customers).
We do not support multiple working on the same Doc at the same time. One user may lose any edits. This is helpful information to know so if one person is already working on a Doc, you don't mistakenly make other edits and possibly cause data to be lost.
Following a Doc is only available for internal team members. So what does following a Doc actually mean? Simply put, you'll get notifications of all new comment threads.
If you've created a Doc, you'll automatically follow the Doc. You can unfollow a Doc by selecting the meatball menu on the top left and select "unfollow".
If you want to follow a Doc, select the meatball menu on the top right and select Follow.
Q: Can my customer share that link with their team member? A: No, those links should only be used by the original invitee.
Q: Does the link sent to my customer expire? A: Yes! The original invite link expires after 14 days. However, if the user requests a new Doc link, it's only valid for one day.
Q: Do all team members have access to a Doc? A: Yes, all Team Members will be able to see Docs in Activities and can be @ mentioned, assigned tasks, etc without being invited. Only admins, the creator of the Doc, and invited team members can edit it.
Q: Can Team Members edit a Doc? A: Yes! Team Members and Observers can edit any Doc they are invited to and share those Docs with other collaborators.
Q: Can I edit a Doc using a Public Link? A: No, users who access the Doc via a public link are considered "anonymous", and will not be able to comment on the Doc or modify any of the data within it.
Q: How do I allow external users to complete tasks? A: Click the task within the doc and assign your task to your organization/account.
Q: Can an Observer be @ mentioned? A: No, observers can not be mentioned.
Q: Can you invite multiple customers from the same Account at once? A: No, each customer must be invited individually as the invitation email includes a unique URL that serves as a username and password.
Q: What happens if a customer uses a different computer or browser? A: Simply navigate to the doc URL using the link from the invite email. You’ll then be prompted to put in your email address. If that email address is invited to the Doc, a new invite email will be sent right away!
Q: What happens when a customer shares the Doc with someone who isn't invited/shared? A: If the document URL is shared with someone that doesn’t have access, they will not be able to see the document.
Q: What is the max file size I can upload in a Doc? A: 10mb
Q: If I make a Doc public, is this public access read-only, or is there any edit ability? A: Read-only. That includes comments! Only people who are manually invited can leave comments.
Q: What happens when a project template is inserted into a Doc template? A: Once the Doc is created, we will create the project too.
How To | How To Visual |
---|---|
How To | How to Visual |
---|---|
Tasks | Task Visuals |
---|---|
Projects | Projects Visuals |
---|---|
How To | How To Visual |
---|---|
How To | How to Video |
---|---|
How to | How to Visual |
---|---|
How to | How to Visual |
---|---|
Q: The value of a trait is different in a Doc compared to when I view it in the Account 360? A: You can check an option if you want the latest value of the trait to show regardless of where the update was made.
How to create Docs Via the Global Create New Button:
Select the Create a New button on the bottom left
Select Create a Doc towards the top left
Select an Organization or Account this Doc is for, or if this is a Team Doc
Select a Template if you want to use one
Name your Doc
Select Create Doc
*NEW* add pages for multi-page docs
If you've select a template, you'll see all that data populate and you can update as needed
If you didn't select a template, you'll see a blank Doc to edit
At the top you can add any Tags if applicable
To share a Doc, simply select the share button on the top right and either invite specific email addresses or make it public. To learn more on sharing read #docs-collaboration-and-sharing
If you need to delete or want to unfollow, select the three dots on the top right.
Adding Commands or Variables
A backslash (/) is to add commands like heading, text, bulleted list, etc.
A curly bracket or brace ({) is to add in variables at the Organization or Account level like Name, MRR, Churn Date, Number of Users, etc.
Navigate to your Settings (⚙️) by selecting your Account Logo on the top left and under Vitally Objects select Docs
Then select Templates (or via Quick Jump Mac: ⌘ + j
Windows: Alt + j
)
Select New Template on the top right
Add a name and a description for your new doc
*NEW* add pages for multi-page docs
Start creating your template!
Adding Commands or Variables
A backslash (/) is to add commands like heading, text, bulleted list, etc.
A curly bracket or brace ({) is to add in variables at the Organization or Account level like Name, MRR, Churn Date, Number of Users, etc.
Embed existing tasks
Type a backslash (/)
Scroll down to select Task
Start typing the name of an existing task and select to embed
As long as the task is created and assigned to the same Account you'll see tasks populate as you start typing.
Embed new Tasks
Type a backslash (/)
Scroll down to select Task
Type out your task and press enter
Embed Projects
Start typing backslash (/)
If in a Doc template
Scroll down to select Project Template. Project Templates will popuate or you can type a name to narrowly search search for a specific Project Template
If in a Doc assigned to an account
Scroll down to select Project. Existing projects will populate or you can type a name to narrowly search for a specific Project
Using Variables in a Doc
Simply type a bracket ( { ) to get your Org and/or Account variables to populate
Select the variable
You can chose to have the current value displayed instead of the recorded value
Trait Permissions: you can configure these traits to be editable by your customer! To do so:
Hover over your variable
A pop-up will appear where you can select or de-select a box to allow invited doc viewers to edit the value
If a trait can not be edited, you will not see this option
Vitally team member permissions have no bearing, this is only for customers (external users).
Additionally, you can check the option if you want the latest value of the trait to show regardless of where the update was made (whether here in a doc, via a playbook, via integration, or manually)
Comments are collaborative where you and team members/users can create a thread within the doc.
To start a comment thread:
Hover next to the text where you want to add your comment
A small text bubble will appear to the right
Select the text bubble and add your comment
Once you're done, you can resolve the comment by clicking the check mark on the top right
Notifications will be sent out if:
A team member/customer participates in a comment thread and a new reply is added to the thread
A team member is following a Doc and a new comment thread is added to the doc
A team member/user is @ mentioned in a comment thread
@ mentioning within the doc or a comment thread.
To @ mention someone:
Simply type @ and team members will populates or you can search
If you want to mention a User in the Account, they must first be invited to the doc. You'll then need to type @ and their email address
Notifications will be sent out if:
A team member/user has been mentioned in a doc
A team member/user has been mentioned in a comment thread
When you select the Task text you'll see a pop-up where you can:
Complete Task
Show to external users or keep it hidden from your customers when they view this doc
Assign to yourself/team members or the Account
Choose your Customer's Partner (a CSM, Implementation, AE, etc)
Add a due date
Add external description (give your customer additional context on this task)
Mark complete or delete
Change Account/Organization assigned to
Update Assigned user
Due Date
Category
Tags
Blocked by
Blocking
Projects
Attachments
Project Traits
There is also a Docs tab right under the name of the Task where you can manage:
Whether to show to customers (external users)
Assign to your customer or another team member
Navigate to the Doc the Task is embedded in
Add an externally visible description of the task
To invite a customer or team member via invite-only to a Doc you can:
Select Share on the top right of your Doc
You'll see a pop up where you can add specific email addresses
You'll be able to select from a drop-down of internal team members and users if this Doc is for an Account.
You can also manually add an email address if they're not part of this dropdown list!
When a user is invited to a Doc, they are emailed an invite with an authentication link. There, they can select Accept Invite. Once they accept the invite, they’ll be redirected to the Doc and be able to start collaborating. It’s best to bookmark the webpage so that you can easily access it again.
Not sure if they've accepted the invite? Navigate to the Doc and select Share on the top right. You'll be able to see whether the user has accepted the invite. If 'invite sent' is still present then the user has not accepted this invite yet. If they've accepted you'll see 'invite accepted'.
This link is unique to each user and should be treated like your username & password. The original invite link expires after 14 days. However, if the user requests a new Doc link, it's only valid for one day.
To invite a customer or team member via public link to a Doc you can:
Select “Share” on the top right
Select the drop-down at the bottom of the pop-up where you can toggle between External access is invite-only or Anyone with the link can view.
Here is where you can gain access to the link by selecting "Copy Link".
This link is shareable not just by you but by anyone. ANYONE with this link will have access to this Doc.
Once you've created your doc with relevant information, you may view the shareable version of the doc by selecting the Play button () on the top right
You can resolve comments by hovering over the comment and selecting the check mark
Selecting the expand arrows icon to the right of the task you'll get the traditional task slide out where you have more information to update like: