We also talk about some of the projects that you might have a documentation Virtual Assistant create for your company. These projects might include Installation Guides, an Online Help Desk, an Online Knowledge Base, User Manuals, and User Forums.
There are basically 4 kinds of documentation. They are
Learning-oriented tutorials
Goal-oriented how-to guides
Understanding-oriented discussions
Information-oriented reference material
All of these are used in the projects that we do.
Installation Guide
An Installation Guide is a technical document intended to help customers install, uninstall and upgrade a particular program. The Installation Guide usually includes a section on the minimum system requirements, sections with detailed steps-by-step instructions on installation methods, and a section on common installation errors and how to correct those errors.
An Installation Guide is frequently written by the software developer or at least a member of the software development team. The problem with this approach is that the software developer tends to gloss over steps in the process because they already know how to install the product. The acceptance of the Installation Guide will be greatly increased if the Installation Guide is re-written by a technical writer who is knowledgeable about software and / or technical installation processes. In this way, the installation Guide can be made more complete and easier for your customer to understand.
Online Help Desk
An Online Help Desk is a way for your support team to collaborate, communicate, and resolve customer support issues. The data that is collected through the support tickets can be used to tighten functionality issues. The best benefits of an Online Help Desk is the way it is easier for your support team to collaborate.
An Online Help Desk can move your company and product to the next level. As with the other online documentation, the articles in an Online Help Desk should be reviewed and edited by a technical writer.
Knowledge Base
The support processes can be opened for use by the customer for self-support. You can extend that knowledge into an online Knowledge Base that contains a repository of solutions for commonly asked questions.
An Online Knowledge Base can move your company and product to the next level. As with the other online documentation, the articles in an Online Help Desk should be reviewed and edited by a technical writer.
User Manuals
A user manual is a document provided to a user that helps in using a particular system, product or service seamlessly. It is also known as an instruction manual or a user guide. Such documents cover detailed information around operations, standards & guidelines, troubleshooting guides, functionalities & more.
User Forums
A User Forum provides a place where customers can ask and answer questions as well as share ideas on a common platform.