Skip to content
English
Create ticket
  • There are no suggestions because the search field is empty.

[MAL - Article Title: Describes the main area or topic the article belongs to. Should make it easy to understand what type of content the article contains.] (klone)

[Introduction Briefly explains what the article is about. Should clearly tell the reader what they will learn and what problem is being solved.]

[Table of Contents]

Optional to add, but very useful to customers for longer articles. Use Insert > Anchor Point to add an Anchor next to a heading, and add a link of type "Link to Anchor" to map it to the anchor. Try by pressing "Before you publish" below.

[Requirements]

[Write short and descriptive bullet points describing what requirements needed to get started using said feature and how to find it.]

  • Feature does A

  • Feature does B

  • Feature does not do C

🛠️ Usage Instructions

[Explain step by step how the reader should proceed to solve the task or problem, or utilize the features capabilities. Use clear structure and formatting. See below for formatting examples]

💡 Remember to use "Callouts" (Insert > Callout) to draw the Users attention. Add callouts, tips, or best practices where they provide extra value for the reader.

  • Use headings level 3 and 4.
  • Bold text for important points
  • Bullet lists and numbered lists where appropriate
  • Add images or videos to make it easy for the reader to understand how to proceed
  • Add Horizontal Divider to break up your article into sections, making it easier to read and follow, like we have below

Example(s):

🔹 [Usage step #1]

  1. Go to Some > Location

  2. Enable module.

🔹 [Usage step #2]

  1. Go to Some > Other > Location

  2. Create something.

🔹 [Usage step #3]

  1. These are just

  2. Examples..

  3.  

🧪 Validation / Testing

[Explain to the Customer how they can check if they have set things up correctly, or followed the guide appropriately]

  • User can see that everything is working by checking X or Y

  • You should validate the article by using it after you write it.

🧯 Troubleshooting & Known Issues

  • Known Issue: [Solution]

  • Known Issue #2: [Solution]

Known Critical Bug: <Detail issue with who to contact to get this fixed>

 

🚨 Before you Publish 🚨

  1. Click "Settings" in your Hubspot Knowledge Base article

  2. Select a Category and a Sub-category, usually Category should be "Help articles", and Sub-category should match the general product area for the feature you are describing.

  3. Add some relevant Tags and write a meta Description (max 140 characters) outlining to search engines what this article is about.

    1. Paste the article intro into an AI and ask: “Rewrite this as a meta description for a help article (max 155 characters).” Copy the result into the Meta description field under “Settings” in HubSpot.
  4. Images
    1. Ensure all images are English language. Make sure you have added ALT text describing the image to screen readers.
  5. Remove this section (Before you publish)