How to Create KB Articles

Article Overview:
As there’s many ways which content creation can be performed and type of information, method of delivery all can vary depending on the nature of the business industry involved.

At the time of writing this article, this information was provided as an informational guide to help anyone being an author for drafting a KB articles which can then be reviewed and approved for publishing. It’s with the hope towards helping everyone in building a valuable knowledge base for everyone at WinMagic. Please note that depending on whether you are creating public-facing article or internal one, it’s important to understand which process to follow when creating the article.

As this document may be revised frequently, it’s recommended for you to reference this document for any new information as it becomes available including any established process has been revised regarding KB content creation. This will include how to create KB articles and the information you will need to be aware of prior to publishing an article.

KB Content Categories:
Categories of the content topic covers, can be very diverse. Content topics can be as simple as: understanding how something works or, requiring information on how to complete a process or, steps within SecureDoc. Since these topics may be hard to categorize due to it’s nature and complexity, such as more complex issues involving specific error codes or other unexpected behaviors; this section provides the general content categories for reference on classifying the article you are authoring.

The content categories at the time of writing this document is a proposed guide on which category you will want to reference when creating your document article.

What’s your content about?
How to Guides
Information Guides
Frequently Asked Questions
Recommended Best Practice
Securedoc Error Codes
Security Advisory information
Product Limitations
Information for WinMagic Staff

1244 Access to Sophos KnowledgeBase, Documentation, Community Forum