Everybody needs some help from time to time, and with the Help Docs feature of Teamwork Desk you can help your users 24/7
With just a few clicks you’ll be up and running.
How to set up your new Help Docs SiteWhen you first log into Teamwork Desk and select Docs, click Add to create your first site and to start creating your site.
Site Name - What do you want to call your site?
Subdomain - Your subdomain can be a combination of letters and numbers and will look like
Description - Add a description for your site
Add the first article
Edit Article - This tab is where you’ll provide the answers to your user’s questions
TeamworkDesk docs has multiple formatting options including Out / In Dents, Bold Italic, Ordered and Unordered Lists and much more.
Insert images into your docs so your users know exactly what you’re referencing. To add an image click You can then either choose a file or drag and drop a file right into the Insert image window.
You can resize any image that you upload by clicking on it and resize it by dragging the resize icon at the bottom of the image.
Having video examples is incredibly helpful and you can embed them directly into Helpdocs articles. Select and copy and paste the link to your video, or in the Embed tab you can add your embed code directly, to show the video within the article.
Maybe you want to offer your users an opportunity to download a file. You can insert any file into your doc by clicking You can then either choose a file or drag and drop a file right into the Insert File window.
To insert a link, click selecting insert link.
You can search for an existing article in your Helpdocs site from here and the URL and title of that article will automatically be added. The article title will be pre-filled in the Text field, and you can replace it if you prefer. If you already have a URL that you'd like to add manually, you can leave the Search field empty, paste the URL directly into the Link field and add the link text to the Text field, then click on the Insert Link button to add it to the article.
Select the Align Text button to align your text to the left, right, center, or justify the text.
If a user is reading one article, say on passwords, then they might also want to read about security. This is where the related articles feature come in.
From the dropdown, select the articles that you want to relate to the current article, and click save.
Revisions allow you to see each change that has been made to a doc, from the very first change right up to the most recent
The easier it is for a user to get an answer, then the better the user’s experience and everybody wins. That’s where Categories comes in to helps you organize all your support Docs in easy to find locations. Individual Categories may be named whatever you want. To create your first category, select New Category (while creating your first Doc). To create your first category select New Category (while creating your first doc)
Give your category a name and click Save
The article that you’ve now created is part of a category called Passwords
Changing the Status from Draft to Published will now make your doc go live to the world (double check for typos before hitting Published)
Adding New Categories / Editing Existing Categories
You can add new categories when creating a new doc, or clicking the settings cog wheel on the lower left and selecting Help Docs - Categories
To add a new category type your new category name and then select Add.
Edit an existing Category
To edit an existing Category, click the pencil icon to the right of the category name
This brings up the Edit Category box, where you can edit the Category Name to something else, you can chose to nest the category under another one (or make it a top level category)
You can also give the category a slug, which will make up the final part of the page URL. So if the slug is “passwords” then the page URL might be yoursite.teamwork.com/passwords
Switching on, “On Homepage” will allow that category to be on the front page of your docs site.
Old URL: If moving from another system to Teamwork Desk, you can input the Old URL of a specific category (you can also do this for individual docs) and TeamworkDesk will automatically redirect them to the new version.
Settings - Help Docs - Appearance
You don’t need to use the default look of TeamworkDesk Docs. We have lots of appearance options so you can customize your very own awesome look. From logos, colors, templates, and even style sheets, there are lots of ways to put your own unique stamp on your brand new Docs Site.
To upload a Logo, favicon, or even a Touch icon, click the relevant upload button.
Browse to the file that you wish to upload, and click upload.
Logos will be resized to 300x80 and JPG, GIF and PNG formats are accepted
Favicons should be 32x32 and ICO and PNG formats are accepted
Touch Icons will be resized to 152x152 and JPG, GIF and PNG formats are accepted
Customise the colors within your docs site from the Page Background to the color of the Links
You can either enter the HEX code or select from an extensive color palette by clicking on the current color.
TeamworkDesk Docs also offers a number of options for templates including the Header, Footer, Article, Category, Home and Search.
Download a sample to see what the code looks like, and when you’re ready to go, just copy and paste your code into the available box. Finally click Save Changes.
To upload a style sheet click and browse to your style sheet and select upload.
Settings - Help Docs - General Settings
In general settings you can define or change your site name, your subdomain, add a custom domain and much more.
Site Name is where you name your docs site.
Public site - If this is turned on, then your site is live on the internet via the sub domain (or the custom domain you’ve selected)
Sub-domain - This will be your URL for your docs site. It will always be yourdomain.helpdocs.com and you can change this to what you wish.
Custom Domain - If you wish to use a custom domain, such as docs.yoursite.com this is where you enter that address. Please note that changing a CNAME is done through your domain provider. The process is easy enough if you have some DNS experience. Generally the steps are
- Create the CName record.
Simply create a CName record and point it to your Teamwork Desk site (eg. docs.yourdomain.com). (You usually do this with the company you registered your domain name with eg.GoDaddy.com)
- Verify the CName record is working.
Once you have created the CName record and you have verified it is now pointing to your site, enter the custom domain into the above section.
Home Page URL - Add a link to your website’s home page
Site Description - A description of your site goes here
Meta Description - Search engine’s love Meta descriptions, make sure you put yours in here
Show on Home Page - Select what you want to show on your docs home page. Categories? Most Popular Articles? You decide
Let your users get in touch direct from your docs site by turning on the Contact Form