Skip to main content
Version: Next

Create an FAQ

Learn how to create a question/answer in the knowledge base.

Procedure

  1. Click on [+ New FAQ]

    Create FAQ button

  2. Fill out the form

    FAQ creation form

  3. Submit for validation

Creation form

FieldRequiredDescription
QuestionYesQuestion as asked by users
AnswerYesClear and detailed answer
CategoryYesTopic (Quality, HR, IT, Production, etc.)
KeywordsNoTags for search
AttachmentsNoAdditional guides, diagrams

Writing tips

Question:

  • Phrase as the user would ("How to...")
  • Be specific
  • One question per FAQ

Answer:

  • Clear and structured
  • Use bullet points
  • Add screenshots if necessary
  • Be concise but complete

Validation

The validation workflow:

FAQ validation workflow

  1. Writing by the creator
  2. Submission
  3. Validation by the manager
  4. Publication (visible to everyone)

See also: