SetUp product documentation
v.20250107
Let us first understand the structure of knowledge in HelpBus.online. Level 1: Products Set the general outlines for your product documentation (where product is also referring to services, software applications …etc). A product documentation can cover one or multiple versions of your product, if these versions share the same documentation. Multiple versions of documentation can be managed with no need to setup different products. However, for each language of the documentation you have to set-up different products. Level 2: Topics For each product topics can be added. They are like chapters in the product documentation. Topics are displayed in the documentation content and one web page is generated for each topic. The topic pages are then to be filled with topic content including headlines, paragraphs, different types of special pre-defined sections and even errata/updates to your documentation. (see the related chapter for different types of topic content). Questions, Features requests and Answers At the general level of topics and on the level of topic content users can ask questions or submit requests for new features. Answers can be provided by you or by other users. Users can answer to their own challenges. A mechanism is in place to highlight the content that is consistent and relevant.
|
Powered by: | ![]() |