---
title: "FAQ documentation (Server/DC)"
canonical: "https://support.covectors.io/space/CAD/570327078/FAQ%20documentation%20(Server%2FDC)"
format: markdown
---
FAQ for Confluence is designed to help you build FAQ pages filled with frequently asked questions and answers organized by categories. 

The app deals with a variety of use cases (Product documentation, guidelines, knowledge base, among other) and helps you better connect with your workforce, facilitate access to information and save time for users.

FAQ for Confluence is available on the three hosting options: Cloud, Server and Data Center. For more information about the differences between the three hosting options along with a clear migration path, please refer to these links.

# Get started with FAQ


Your journey with the FAQ app starts by creating your first FAQ page. For this, you have to go through the following steps:

1. Select Create from the top menu
2. Choose “Discussion” from the dialog box

![image](media://265e8f9c-304d-40c3-90d8-5fdcf641eb5e)

3. Fill the FAQ creation form: Add the title, owner(s), description, and tags.

![image](media://56324e60-514c-4e0b-a49a-5a0fac002427)

And there you have it, your first FAQ page has been created. 

# FAQ page

Now that you have created your first FAQ page, you can start adding categories and listing questions and answers. 

In this section, we will walk you through the FAQ page layout along with its different macros. Then, we will detail the process of creating both topics and questions.

## FAQ page Layout and macros

The FAQ page consists of multiple macros aimed at enhancing navigation, making information readily available and, of course, facilitating the creation of questions and answers.

![image](media://0df71286-413f-4f58-b204-45f150581cc2)

![image](media://7796f221-36f0-4c20-9ae0-d67c11e42b9c)

You have complete control over the page’s layout. However, in order to ensure a better user experience, we advise you to use the four available FAQ macros: FAQ overview, FAQ question, FAQ summary, and FAQ topic.

To edit, add or delete macros, click “Edit” on the top right. 

** FAQ title:**This is the FAQ title followed by the creator and the creation date. 

** FAQ summary: **This macro contains three items:

- About this FAQ: A brief description of the FAQ page.
- Owners list: This item contains the list of FAQ owners. By owner, we refer to a user who has created a question or contributed to the FAQ page.
- FAQ statistics: you can visualize important data about your FAQ page such as the number of questions, categories, up votes, and down votes.
- Various shortcuts: From within this macro, you can add new topics, create, suggest and search questions.

![image](media://5e4ca522-7592-49f8-bea0-27749d61c3ec)

![image](media://a66c903b-2731-430c-a1bb-38767b2a8323)

**FAQ Topics**

This macro contains a list of topics along with the number of questions within each one. The macro is designed to help you easily navigate the FAQ page.

![image](media://7c9b0c86-13d5-4cdb-99b0-bfa24d68e4da)

![image](media://f3e09eb1-f3b8-4c5a-a809-64a04cedd40d)


**FAQ Questions**

Questions are displayed under their specified categories. Click on the question to show more details. The app comes with two default questions as examples.

![image](media://78638e81-3692-4413-9d8b-96abbb7f1835)

![image](media://fc147b92-6272-43a4-9a56-fb69a9a868fa)

Now that you have an idea about the FAQ page layout, let’s walk through the process of creating both topics and questions.

# Topics

## Add topics

1. From the FAQ page, click “New topic”
2. Enter the topic’s name
3. Click Add

![image](media://6c3bc67c-9716-47a8-961d-570386a7718f)

The topic will be added within the “FAQ summary” macro under the topics section. Additionally, a dedicated topic macro will be created containing the topic’s title and its questions (As seen in the screenshot below).

![image](media://897553df-085e-41bb-b522-10bda316e734)

## Edit topics

1. Click “Edit” on the top right
2. Navigate to the topic macro and click Edit

![image](media://d1e83341-8012-4b56-af1b-1604df507150)

  3. Edit the topic title. A real-time preview is displayed on the right-hand side of the menu to help you visualize changes in real-time.

 4. Click Save and then Update to visualize the changes in view mode

![image](media://0676b3eb-f354-494d-b209-f4937f265d60)

## Delete topics

1. Click “Edit” on the top right
2. Navigate to the topic macro and click Remove

![image](media://55d8f42e-db00-4680-87dc-d067125df540)

The topic macro will be removed. If you would like to cancel your action, select the Undo button or Ctrl + Z.

## Questions & Answers

## Add questions

1. From the FAQ page, click “New question”
2. Specify the question’s topic
3. Add the question along with the answer
4. Specify the question’s label (Optional). Make sure to separate labels by space.
5. Click Add

![image](media://484a4d38-08ae-418d-9cd4-312e4fafedf6)

The question will be added under its specified topic as shown in the screenshot below

## Edit questions

1. Click “Edit” on the top right
2. Navigate to the question macro and click Edit
3. Edit the question’s text and change the label(s). A real-time preview is displayed on the right-hand side of the menu to help you visualize changes in real-time.
4. Click Save and then Update to visualize the changes in view mode

![image](media://c989378f-d69f-48c1-ad6d-74376cf1914f)

To edit the answer, just enter the changes directly within the question macro and click Update to visualize the changes in View mode.

## Delete questions

1. Click “Edit” on the top right
2. Navigate to the question macro and click Remove

![image](media://916ee270-943c-4dee-b21a-cd6685126b3b)

The question macro will be removed. If you would like to cancel your action, select the Undo button or Ctrl + Z.

## Rate questions and add feedback

Below each question, you have the option to leave feedback. For this, you have to reply to the following question “Was this answer useful?”.  

You can answer the question by selecting Yes or No and providing your feedback in the comments section (Optional). Your answer is directly linked with the votes count. Selecting yes or no will respectively increment the number of votes with (+1) or (-1).

![image](media://2a5cad30-10fd-46d9-8c4b-ed3907c1dbbe)

Once you click save, your answer will be highlighted in the comments section of the FAQ page as shown in the screenshot below. The generated comment contains the question, of whether it was useful or not, and the feedback.

![image](media://28e737c3-2cc2-419a-9b55-c182f1158047)

## Suggest questions

For the latest versions of the FAQ app, we have provided users with the possibility to suggest questions they might have not found on the FAQ page. This is particularly useful for users who do not have the right to add questions or edit the FAQ page.

1. Click “Suggest”
2. Enter the question along with a brief description and select suggest

![image](media://e9cc2fff-e0dd-41e9-98eb-ba7d530c3984)


The suggested question will be highlighted in the comments section to make it easier for the FAQ admin to identify it. The comment contains the identity of the user, the suggested question along with the description.

![image](media://965d854d-ab71-4832-963a-d624a3538708)

## Search Questions

You can easily search and locate questions by leveraging the built-in search function. To search a question:

1. From the FAQ page, click “Find”
2. Specify whether the search will be based on labels or content
3. Enter the search query

![image](media://74375354-799f-4a74-ba77-78563ae68b37)

4. Click “Find”. The result will be shown within the dialog box.

![image](media://3e3c9957-7504-4736-9291-18e2ef27c88b)

5. Select one of the results and click “Find”.

# FAQ Index

The FAQ page you have just created along with the ones to be created in the future are all listed with the **FAQ Index page.**

Think of the **FAQ Index page** as both a parent page and a dashboard containing all the relevant information about FAQ pages, questions, topics, contributors, and more.

The FAQ Index page consists of one single macro composed of multiple items. 

We brought several enhancements to this dashboard by adding filtering capabilities and some statistics displayed as shown in the following screenshots.

![image](media://804c4ac4-7ba9-4503-9241-14f4e56db961)

![image](media://b163ac70-e520-4889-845c-7c99d9c78ab7)

You have complete control over the layout of the FAQ Index page as well as the info to be shown within both views (board or list view). 

For this, click on “Edit” on the top right of the page. You will land on the edit mode where you will find one single macro called “FAQ Overview”. 

Select the macro, and click “Edit”. A dialog box will appear; on the left, you have all the parameters that you can manage including:

- Set the information panel to display by default
- Display recently created FAQs panel
- Display FAQs statistics panel
- Display FAQs feedbacks panel

![image](media://4a40a5b2-76ae-43f4-affc-f0c22c99917e)

Select the parameters you want to include in the view, click “Save” and then “Update” to visualize the changes in view mode.