How to Create a TOM Article

Introduction

Adding a TOM article will be necessary from time to time. If you have a suggestion for a new article, please use the Green Chat icon in the bottom right of each TOM article or the ACT Links page. This will send a message to the Training Team.

If you have been contacted by the Training Team to add a new TOM article, please follow the instructions below.

What to do

  1. Log in to the Dashboard of our website
  2. Open BetterDocs
    • Click on BetterDocs on left had side
    • Make sure you are in BetterDocs UI view
    • Select + in the Category you wish to add to
  3. Adjust the settings
    • Decide a URL Slug
    • Check the correct Categories for the article to appear in (always including Glossary)
  4. Structure the article:
    • Title
    • Introduction
    • What to do
    • How to
  5. Select Publish in the top right hand corner
  6. Order the article in the correct Categories, including alphabetically in the Glossary

How to

  1. Log in to the Dashboard of our website
    • Go to the ACT Links page and select ACT Dashboard or click here
    • The Password will auto populate
  2. Open BetterDocs
    • This is found on the left hand side menu, under Posts
    • Click on the title BetterDocs
    • Make sure you are in BetterDocs UI View
      • “BetterDocs UI View” found in the BetterDocs Menu title bar
    • Go to the Category you wish to add to (People, Systems, IT, Marketing etc.)
    • Press the big + button at the end of the articles in that Category
  3. Adjust the settings
    • The settings are found on the right hand panel, when “manual” is selected
    • Decide a URL Slug
      • The URL Slug is the website address of the article
      • All TOM articles have the address actorscreativeteam.co.uk/tom/SLUG
      • Make it short and specific, with any words separated by a hyphen
    • Check the correct Categories for the article to appear in
      • Under Categories, Select the category you want your article to appear in
      • Make sure to always select Glossary too
  1. Structure the article:
    1. Title
      • Make this a clear title, which does what it says on the tin, e.g. How to Create an Invoice
      • After the Title, you progress down the document by adding sections. These sections could be Paragraphs, Numbered or Bulleted Lists, Images, Quotes, Headings and many other options
      • If you press the return key, you will automatically start a new Paragraph, which is simply a way of writing text in the house style
        • To change the style of the Section, hover over the text, a menu will appear
        • By clicking on the far left icon, you can change the image
        • By using the up and down arrows you can position it in the article
      • The following three Sections should be set to Heading and H2 style
    2. Introduction
      • This should be a few paragraphs to explain the importance of the article and why we do what we do
    3. What to do
      • This is an ordered list of what to do. You may know how to make an invoice for example, but you just need to know the ordered steps in which to do things and to be able to check you haven’t missed anything.
      • See above for an example!
    4. How to
      • This is a detailed step by step breakdown of the actions you need to take and how to do them
      • If the article explains a TagMin function, try to explain every field you will encounter, even if we do not use them.
  2. Select Publish in the top right hand corner
    • In the top right hand corner of the screen, there will be a box that says Publish in a blue box (it will say “Update” if you are only editing an article). Once it is published it will be viewable in TOM.
  3. Order the Article in the correct Categories
    • Go back to website Dashboard
      • Go to the ACT Links page and select ACT Dashboard or click here
    • Hover over the BetterDocs tab
      • Select All Docs
      • View in “BetterDocs UI” (you may have to Switch to BetterDocs UI view)
        • We need to be able to drag the articles into the order we want them, to do this we need to be in the BetterDocs UI view.
          • “BetterDocs UI View” found in the BetterDocs Menu title bar
      • Scroll to the Category your Article has been made in
        • Drag to a sensible order in the list
      • Scroll to Glossary Category
        • Drag your new article in alphabetical order