This article serves as an internal guide for producing effective knowledge base articles.
- Before generating a new article, please verify the existence of any articles covering the same or similar topics. Duplicate content can congest the knowledge base, diminishing its effectiveness.
- Articles should primarily emphasize the use of our latest and most advanced products, such as GI.bench, rather than older products like test.commander.
Style Guide
- Italics denotes emphasized text.
- Interface refers to entries and entry fields within the user interfaces.
- Options indicates menu items within the user interface.
- ">" signifies a sequence of menu items, for example, Settings > General.
Optimization of articles for optimal visibility and relevance
To ensure that our knowledgebase articles are easily found by search machines, it is essential that they be informative and detailed. The minimum word limit for articles is, therefore, 500 words. Each article should be interesting and highly informative.
It is important that each article has a clear meta description with a maximum of 150 to 155 characters that encourages readers to open and read the article.
The URL of the article should be short and meaningful to ensure better findability. An example of an optimal URL structure would be: knowledge.gantner-instruments.com/profinet-io-plugin instead of knowledge.gantner-instruments.com/plugin-ginspniodevice.
Ideally, the main search keyword should also be included in the subheading of the article to improve its relevance for search engines.
As we generally write articles in English, they have to be translated for the German target group to ensure that they can also be found in German.
Control audience access
Within the article settings, users have the ability to manage the privacy settings and control the accessibility options for visitors.
Public (default)
By default the articles are set to Public which makes htem available to everyone without haveing to login. Use this option for to share any information about our products that is not competitor or sales sensitive.
Private - Registration required
Select this option to limit access to the knowledge base article. You must choose from the existing contact lists in HubSpot to determine who has access.
- For knowledge base articles intended exclusively for the Gantner Instruments support team, please choose: "020_Member Gantner Support and Management Team".
- To designate knowledge base articles for both our internal sales team and external sales partners, please select the following lists: "2016" and "1937".