Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionFAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process. 
Doctypedoctypehide
NameFAQ 
IDfaq 
SetCore 
Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ1 - Process, Q2 - Project, Q3 - Product, Q4 - System
propertyDocumentation Type
 
Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
namesDocumentation
propertyDocumentation Type
 
Tags
Tag List
namesCore, Project
 

Iteration
Iteration
valuefocused
hide
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

The main purpose of a question and answer document is to make it easy for readers to find answers to their question. It is easier to match one's question in an index, than to run a number of searches on a pile of documents. So in essence a FAQ is a tool for readers to get an answer quickly.

But make sure that the FAQ is short and focussed. There is very little structure in this list and the simple question/answer format may be too easy to pour any information in. Instead documentation should be structured and goal orientated.

Tip Box

Read The problem with Frequently Asked Questions (FAQs) in documentation by Tom Johnson for more information on FAQs and how they should be used properly.

Section
titleProperties

The document type provides only standard properties.

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-doctype
Typecore