1. Adding new articles to the Knowledge Base
- Make sure you are logged in to the Tech Community
- Go to the Knowledge base home page
- Click on +New wiki button
- Enter the content of the article or tutorial and hit Create wiki once you are ready.
Please let us know if you face some issues or need assistance.
For basic instructions on using the Knowledge base, please refer to the sections below:
Make sure the title is a meaningful one. We recommend you include the full name of the product or feature you are writing about.
Your article can be formatted using simple HTML, BBCode, or Markdown:
This is <b>bold</b>. This is [b]bold[/b]. This is **bold**.
For more formatting tips, try this 10-minute tutorial.
Drafts will automatically be saved as you write. If you minimize the editor or navigate to a different topic or article, the editor might disappear. To open a draft, return to the topic you were replying to or click the highlighted bar at the bottom of your browser, and the editor will reappear with your draft.
You can upload additional documents, images, code samples, and etc.
‘Tags’ field is mandatory and will answer the question ‘Where does this content fit in?’.
If tags are missing you will not be able to save and publish your article. You can add as many tags as you wish. For your convenience use the checkbox list under Select Tags.
Here are some of the benefits of adding the right tags:
- Your article will appear on the relevant product landing pages
- The content will appear under the right product category
2. Knowledge base Page content
A good article consists of:
The intro is a short summary of your article or tutorial. The introduction provides context and gives a brief overview of what the article includes. Few recommendations:
- Keep it brief - Introductions don’t have to be long.
- Present the reason for the post’s existence
- Include details on an applicable version - this will help to identify the relevance of the resource at a first glance
2.2 Different content sections
When structuring your page make sure you use different heading styles so that the content can be digested easier.
2.3 Good structure of your articles
For a better reader experience, here are some recommendations:
- Title: Make it easy to comprehend, preferably use full product or feature names (e.g. use webMethods Integration Server instead of IS or Cumulocity instead of C8Y)
- Introduction: Include brief sentences on what is the purpose of the article and to whom it may be useful
- Headers: Use H2’s to emphasize the major points of your article, use H3 to list references
- Tags: At the bottom of the article you can set tags that will help to make the article easier to find and access. For your convenience, you can select the tags from the checkbox list under the editor
- Don’t create one huge article but instead split it into an easy to follow series of tutorials. Make sure they are interlinked at the right places so that a user will jump to the next section.
2.4 Oneboxes (Link Previews) and embedded videos
To generate a summary for a link, paste it on a line by itself. A summary should appear.
The Tech Community also allows you to include videos in your post or article. When you want to embed a video, you just need to paste the link to it.
3. Help develop the knowledge base further
3.1 Preview of my article/post
Once you start writing your article in the editor a preview of your article or post will appear on the right-hand side.
3.2 Actions and Reactions
There are action buttons at the bottom of each post:
- To let someone know that you enjoyed and appreciated their post, use the like button. Share the love!
- Grab a copy-pasteable (permalink) link to any reply or topic via the link button.
- Use the … button to reveal more actions. Flag to privately let the author, or the site staff, know about a problem. Bookmark to find this post later on.