This document outlines the steps that you will need to follow in order to create a new FAQ or HowTo in our Support&Services space. Each product or no product related question will be a new page created from an existing template. 

Step-by-step guide

Select the parent page

Choose the parent page of your FAQ.

The FAQs are product related or no product related. The parent pages for the product related questions are:

2018_AirID - FAQ, ONEKEY ID - FAQ, ONEKEY BRIDGE - FAQ, cgPhone - FAQ.

The parent page for the no product related questions is: FAQ - Frequently Asked Questions

Create a FAQ page from a template

Choose Create from template  in the Confluence header

Select the template "AirID FAQ" and click "Create"

Edit the new FAQ

  1. Enter the "Title" of the FAQ. The title is the question that will be inserted also at "Question"
  2. Enter the "Question"
  3. Enter the answer or the steps of the howto in the "step-by-step"- panel

Insert labels

Labels are keywords or tags that you can add to your FAQ page. To add a label please follow the steps:


  1. At the bottom of the page, choose Edit labels 

  2. Type in a new label (existing labels are suggested as you type)

  3. Choose Add

Please choose the labels according to the "Label Guide" below.

Publish your FAQ page

At the bottom of the page, choose Publish

Once the page is published, you can find it in the page tree, under the parent page from which it was created.

 

Label Guide

How to choose a label:

  1. Please do not use abbreviations (e.g. BLE, OKID)
  2. The labels must be meaningful and relevant to customers
  3. The labels must be customer-oriented 
  4. Product specific FAQs must be tagged with:
    1. the product label (e.g. ONEKEY_ID_4, AIRID1, ONEKEY_BRIDGE, cgphone, cgcard) 
    2. the platform label and (e.g. WINDOWS10, LINUX, ANDROID etc)
    3. feature specific label (Bluetooth_LE, NFC, coverage, USB)
  5. Cross-product specific FAQ must be tagged with:
    1. the platform label and (e.g. WINDOWS10, LINUX, ANDROID etc)
    2. "cross_product" label
    3. feature specific label (e.g. smartcard, certificate etc)