Articles in this section

See more

Documentation Center

Ian Alexander
  • Updated
Follow
Welcome to the new and improved Documentation Center!  Here, you can store free-form text like help documents, customer information, user guides, and more.
 

What it does

  • Gives you a place to put content for your team with a nice HTML editor so you can put all kinds of nice looking content including images and videos
  • Easily create parent pages to link them children pages to create a hierarchy
  • Add links to other pages, websites, custom widgets, booking calendars, and more
  • Set document privileges to give all, one, or no customers access to certain documents in their customer portal
  • Add a navigation side bar to organize your documentation internally
  • Create customer specific documentation for each customer utilizing our template tags, making cloning documents for each specific customer that much easier

What it doesn't do

  • Doesn't allow you to store files for download - but you can link to files that are accessible on the internet.
  • Cannot link documents to assets (coming soon). 

Getting Started with Customer Documentation

The customer documentation, located on the main customer detail page, is a place to include many details about your customer both internally, and externally in the customer portal. You can enable it under Admin > Customers > Preferences > Additional Settings > 

 
Now you are set to create Documentation for specific customers that can be accessed either by them on the Customer Portal or for your team on the Customer Detail page. For example, on the Customer Detail page, you will see a Documentation section on the left side
 
 
You can also enable a Documentation Tab for the top navigation bar in Syncro. This can be done by heading to Admin > Tabs Customization > Documentation > Save.
 
Once you have the Documentation Tab turned on, you can also head there to create New Documentation articles.
 
 
Click New in the Customer Detail or on the Documentation page will take you to the Editor where you can begin to build out your document.
 
 
Uploading Images/Files
Once you upload your image, there are 2 options for image size. Clicking either one will copy a URL to your clipboard. Once it's been copied, head to the Insert button > Image > In the Source field, paste the URL and Save. Your image should then load in to the editor. Easy!
 
Now that you have created your article and set it to be visible in the customer portal, you can revisit the customer to view their new link to their customer documentation!
 
wiki4.png
 

You can also click the "Customer Online Profile" link to view what the customer sees inside their portal for their newly created documentation section:

 
wiki5.png
 
Clicking on the document's link will take you to the customer's documentation, with the proper information replacing the template tags you added earlier:
 

wiki6.png

Documentation Templates

Documentation Templates allow you to create a template that you can apply to any document page for an easier way to create multiple wiki pages with a similar format.

To create a Template, add a new page and set the page type to "Template".

You can search for templates using "Template" or "Templates" in the Documentation center search bar.

Once at least one template has been created, you can apply the template to a new or existing document here:

You can also convert a current documentation page into a template and vice-versa by changing the page type. The edit, clone, and delete functionality all work with templates as well.

Masked Credentials

Masked credentials are a way to securely store login credentials, but also make them easy to access without requiring a long password to be entered. Credentials can be added by editing any existing documentation page (templates not included).

Name: This is there to help categorize the credential so you know what it's for.
Username: Usually an email but can be whatever Username type you want (Text Field)
Host/URL: Link to the site if applicable
Password: Click the field to enter a password. Next time the page loads, this field will be starred
Notes: Any notes for the credential 
Public: Choose whether the credential is public or private/internal

Credentials can be added to wiki pages for internal/private use or added to be public wikis in the customer portal.

Masked credentials can also be added to customers and contacts. More information on that here.

Important notes for customer documents: 

  1. If you want the customer to have access to this documentation, set the page type to Customer Portal
  2. If you do not want to associate this page to a specific customer, but would like all customers to have access to this documentation, leave the Customer Name blank
  3. On the other hand, if you only want a certain customer access to this page, please ensure to add the customer's name from the dropdown when typing the name into the text field
 

Getting Started with Internal Documentation

Firstly, we need to find the Documentation Center!  If it is not already in your top navigation bar, make sure to enabled it in under "Admin" > "Tabs Customization".
 
Once you do, click on the navigation tab for "Documentation" to get started! You should see a page that looks a little like this:
 
wiki7.png
 
Once here, you will want to click "New Page" to add a new documentation.  Just make sure to add a Page Name and mark the Page Type as internal, and you should be all set!
 
Keep in mind that you can create "Parent-Child" by adding links to documents like this:
 
 
For internal documentation pages, you will only need to add the "Page Name" of the document to the URL text field.  For external URLs, you will want to add the full URL to URL text field.
 
If there is anything we missed, or you would like clarification on, please do not hesitate to reach out to help@syncromsp.com!  We are more than happy to help. =)

Related articles

Comments

0 comments

Article is closed for comments.