Within Teamwork Desk, you can create individual articles for your Help Docs site.
To create an article, go to the Help Docs area at the top of your site.
Select the relevant Help Docs site from the list. While viewing the site, go to the Articles tab and click the Add Article button in the top right corner.
The Help Docs editor will open where you can enter a title for the article and the main body of content.
The article view is broken down into four subsections:
- Edit Article - use the editor to
add and update your article content.
- Related Articles - add other
existing articles that may be relevant as
related articles. This can help your
readers to easily navigate related pages
without the need to search again.
- Keywords -
can be added to added to any articles you
create. By adding keywords it can help
your readers to easily find what they are
looking for. Add as many as you can and
anticipate what search terms may be used
when someone is looking for this
- Revisions -
a new revision of the article is created
each time someone makes changes.
- The Revisions tab gives a list view of
previous updates made to the article.
- Each entry will show you when the
update occurred, and who it was
modified by. You also have the option
to preview or delete each individual
revision by hovering over it.
To the right of the main article view, you will see a sidebar containing the article's properties.
At the top, you can choose:
- Status - draft, unpublished, or
- When an article is published, it will
appear on your live Help Docs
- You can change the status of an
article at any time by selecting a
different option in the dropdown and
- Categories - select which categories the
article is relevant to.
- Each article must be added to at least
- Save - save any changes made to the
article's content or properties.
- Preview - open a preview of the article to
see what it will look like to your
Under More Options, you can update the slug, relevance, and old URL, as well as enable comments.
The display order (relevance) helps determine how high up the article will appear over others in the search results when a search term is met.
At the bottom of the sidebar, you can choose between HTML and Markdown as your editor type.
To delete the article, select the red Delete Article button at the end of the sidebar.
Help Docs editor options
Editor Options |
source - view/edit the source
code for the article. |
| Redo |
| Italic | Underline |
| ||Clear formatting|
align | Center align | Right
|Unordered/bulleted list |
Ordered/Numbered list |
|Outdent | Indent |
| ||Insert horizontal rule |
| ||Insert/edit link | Remove link |
| ||Upload image |
More options: Text Direction l Left/Right
For more information, see: Creating a Help Docs Site