TDX Knowledge: Enhance Article Content

This supplementary guide is for TeamDynamix (TDX) agents who manage knowledge articles, helping them enhance the effectiveness of their content.

 

In This Article:

 

Adding Table of Content

You can create a Table of Content (TOC) using in-page anchor links.

Step 1: Mark Anchors 

Assuming you are already editing the article:

  1. Locate the text you want to create an anchor for.
  2. Place the cursor to the left of the text (do not highlight the text).
  3. Click the Anchor button.

  1. Enter the name of the anchor and click Ok.

TDX Knowledge editor Anchor Properties dialog window
 

Steps 2: Link Anchors

  1. Select the text you want to hyperlink, pointing to the marked anchor.
  2. Click the Link button.
  3. In the Link Type drop-down menu, select Link to anchor in the text.

TDX Knowledge article editor link dialog link type drop-down menu

  1. In the By Anchor Name drop-down menu, select the desired anchor text.
  2. Click Ok.

 

Inserting Images

Do not copy and paste images, as they may disappear intermittently. Always insert images properly.

Add Block Images

Assuming you are already editing the article:

  1. Go to the end of the step/sentence you wish to add an image after.
  2. Press Shift + Enter (Mac: Shift + Return) to insert a new line break. 
  3. Select the Image icon
  4. Select the Upload tab.
  5. Click Choose File.
    image properties window; upload tab, choose file button highlighted with a file name associated
  6. Click Send it to the Server.
  7. Go to the Image Info tab and enter appropriate Alternative Text. 
  8. Be sure the Lock Ratio padlock is locked before re-sizing the image.   
  9. Set the Border to 1 (unless the edges are already well-defined).
  10. Click OK

 

Add Inline Images

Assuming you are already editing the article:

  1. Click where you wish to add an image.
  2. Select the Image icon.
  3. Select the Upload tab and click Choose File.

image properties window; upload tab, choose file button highlighted with a file name associated

  1. Click Send it to the Server.
  2. Go to the Image Info tab.
  3. Be sure the Lock Ratio padlock is locked before re-sizing the image.   
  4. Click OK
  5. Double-click the image to open the Image Properties window.
  6. Go to the Advanced tab
  7. In the Style field, enter ;display:inline; at the end of the existing text.
  8. Click OK

 

Change Image Settings

  • Double-click the image to open the Image Properties window to make any changes.

 

Checking Content Readability

 

Microsoft Word

  1. Draft your article in Word or paste the content from TDX.
  2. On the Ribbon menu, click Review.
  3. Click Editor. A sidebar will open showing various characteristics of the text.
  4. Scroll down to Insights and click Document Stats.
  5. If a confirmation pop-up appears, click OK. The readability statistics pop-up will display your content's readability scores.

 

Readability Test Website

If your article is published and has public visibility, you can check its readability score just by pasting the article's URL on this site.

  1. Visit the Online Utility Readability Test website.
  2. Paste your article's URL in the Read it from the website box.
  3. Click Process Text.

 

Improving Content with Copilot

You can use Copilot to improve your draft.

  1. Draft your article in Word or paste the content from TDX.
  2. Scroll to the end of the document.
  3. Click the Copilot icon.
  4. In the ‘Draft with Copilot’ textbox, paste the following prompt:

You are an expert Knowledge Base Specialist. Revise the article content to enhance clarity, structure, and consistency. Correct grammatical errors, improve sentence flow, and ensure smooth transitions between ideas. Replace passive voice with active voice where applicable and correct any subject-verb agreement issues. Remove redundancy while preserving all essential information, ensuring the content remains concise, clear, coherent, and professional. Adjust the language to maintain a readability level appropriate for a 9th-grade audience based on the Flesch-Kincaid scale. Ensure all website hyperlinks are masked behind their target page titles to enhance readability and accessibility:

  1. Click the Generate button to receive Copilet's suggestions
  2. Once Copilot provides the output, click Keep It.
  3. Review the Copilot-generated draft and modify as needed.
  4. Use the ‘Paste from Word’ feature when pasting the content into the TDX article body.
Print Article