FAQs Module

The FAQs (Frequently Asked Questions) module allows you to create and manage a comprehensive FAQ section for your website. This guide covers all FAQ management features.

---

Table of Contents

1. Overview
2. Accessing FAQs
3. Creating FAQs
4. FAQ Categories
5. Managing FAQs
6. FAQ Ordering
7. Frontend Display
8. Search Functionality
9. Best Practices

---

Overview

Features

• ✅ Create and manage FAQs
• ✅ FAQ categories for organization
• ✅ Custom ordering
• ✅ Rich text content
• ✅ Search functionality
• ✅ Accordion/collapsible display
• ✅ Frontend FAQ page
• ✅ Bulk operations

Admin Routes

• FAQ List: /admin/faqs
• Create FAQ: /admin/faqs/create
• Edit FAQ: /admin/faqs/{id}/edit

Frontend Routes

• FAQ Page: /faq or /faqs
• Category View: /faq/category/{category}

---

Accessing FAQs

From Admin Panel

1. Log in to admin panel
2. Navigate to Content Management → FAQs
3. Or go directly to: /admin/faqs

Permissions Required

• View FAQs: view faqs permission
• Create FAQs: create faqs permission
• Edit FAQs: edit faqs permission
• Delete FAQs: delete faqs permission

---

Creating FAQs

Step 1: Access Create Page

1. Go to FAQs → Create New FAQ
2. Or navigate to: /admin/faqs/create

Step 2: Question

Question Text

• The FAQ question
• Required field
• Should be clear and specific
• Example: How do I reset my password?

Best Practices:

• Use question format
• Be specific
• Use common language
• Keep it concise

Step 3: Answer

Answer Content

• Detailed answer to the question
• Required field
• Use rich text editor
• Can include:
  • Formatted text
  • Lists
  • Links
  • Images
  • Code blocks

Answer Guidelines:

• Be comprehensive
• Use clear language
• Include examples if helpful
• Break into paragraphs
• Use formatting for readability

Rich Text Features

• Formatting: Bold, italic, underline
• Headings: H2, H3 for sections
• Lists: Ordered and unordered
• Links: Internal and external
• Images: Add relevant images
• Code: Code blocks for technical answers

Step 4: Category Assignment

Select Category

1. Choose existing category
2. Or create new category
3. Can assign to multiple categories
4. First category is primary

Categories Help:

• Organize FAQs
• Group related questions
• Improve navigation
• Better user experience

Step 5: Additional Settings

Status

• Published: Visible on website
• Draft: Saved but not published
• Archived: Hidden from display

Featured FAQ

• Toggle: Mark as featured
• Featured FAQs shown first
• Highlighted in display
• Use for most important questions

Display Order

• Set order for display
• Lower numbers appear first
• Used for sorting within category
• Default: Order by creation date

Step 6: SEO Settings (Optional)

Meta Information

• Meta Title: Search engine title
• Meta Description: Search result description
• Keywords: Relevant keywords

Note: Most FAQ pages use page-level SEO, but individual FAQs can have meta data.

Step 7: Save FAQ

• Save Draft: Save without publishing
• Publish: Make FAQ live
• Save & Add Another: Create multiple quickly

---

FAQ Categories

Creating Categories

1. Go to FAQs → Categories
2. Click Create New Category
3. Enter:
   • Name: Category name
   • Slug: URL-friendly version (auto-generated)
   • Description: Category description
   • Parent Category: For sub-categories
4. Click Save

Category Examples

Common Categories:

• General
• Account & Billing
• Technical Support
• Product Information
• Shipping & Delivery
• Returns & Refunds

Managing Categories

• Edit: Modify category details
• Delete: Remove category (FAQs not deleted)
• View FAQs: See all FAQs in category

Category Hierarchy

Create parent-child relationships:

• Parent: Main category (e.g., "Support")
• Child: Sub-category (e.g., "Technical Support")

Benefits:

• Better organization
• Improved navigation
• Easier to find related FAQs

---

Managing FAQs

FAQ List View

Access at: /admin/faqs

List Features

Search:

• Search by question
• Search by answer content
• Real-time results

Filters:

• Category: Filter by category
• Status: Published/Draft/Archived
• Featured: Featured/Not Featured

Sorting:

• By Question (A-Z, Z-A)
• By Category
• By Date (Newest/Oldest)
• By Display Order

Displayed Information

• Question: FAQ question
• Category: Assigned category
• Status: Published/Draft
• Featured: Featured badge
• Order: Display order
• Date: Creation date

Editing FAQs

1. Click Edit on FAQ
2. Make changes
3. Click Update
4. Changes saved

Deleting FAQs

1. Click Delete on FAQ
2. Confirm deletion
3. Warning: Cannot be undone
4. FAQ removed

Bulk Operations

Bulk Delete

1. Select multiple FAQs
2. Click Bulk Actions → Delete
3. Confirm deletion
4. All selected FAQs deleted

Bulk Status Change

1. Select FAQs
2. Click Bulk Actions → Change Status
3. Select new status
4. All updated

---

FAQ Ordering

Manual Ordering

Drag and Drop

1. Go to FAQ list
2. Enable "Reorder" mode
3. Drag FAQs to desired order
4. Order saved automatically

Set Order Number

1. Edit FAQ
2. Find Display Order field
3. Enter order number
4. Lower numbers appear first
5. Save changes

Automatic Ordering

Options:

• By Date: Newest first
• By Question: Alphabetical
• By Category: Grouped by category
• By Featured: Featured first, then others

Ordering Within Categories

• FAQs ordered within each category
• Category order also configurable
• Featured FAQs appear first in category

---

Frontend Display

FAQ Page

URL: /faq or /faqs

Features:

• All published FAQs
• Category filtering
• Search functionality
• Accordion/collapsible display
• Responsive design

Display Formats

Accordion Style

• Questions are collapsible
• Click to expand answer
• Only one open at a time (optional)
• Clean, organized look

List Style

• All FAQs visible
• Scrollable list
• Easy to scan
• Good for few FAQs

Category Tabs

• FAQs grouped by category
• Tab navigation
• Switch between categories
• Organized display

Category Pages

URL: /faq/category/{category-slug}

Features:

• FAQs in specific category
• Category description
• FAQ count
• Same display format

---

Search Functionality

Frontend Search

Features:

• Search box on FAQ page
• Searches questions and answers
• Real-time results
• Highlights matching text

Search Results

Display:

• Matching FAQs shown
• Question highlighted
• Relevant answer excerpt
• Link to full FAQ

Advanced Search

Options:

• Search within category
• Filter by date
• Sort results
• Show/hide answers

---

Best Practices

Writing FAQs

1. Use Clear Questions:

   • Write as users would ask
   • Use common language
   • Be specific

2. Provide Complete Answers:

   • Answer fully
   • Include examples
   • Add links if relevant
   • Use formatting

3. Keep It Updated:

   • Review regularly
   • Update outdated info
   • Add new common questions
   • Remove irrelevant FAQs

Organization

1. Use Categories:

   • Group related FAQs
   • Create logical categories
   • Use sub-categories if needed

2. Order Strategically:

   • Most common first
   • Featured FAQs prominent
   • Logical flow

3. Maintain Quality:

   • Regular review
   • Check for accuracy
   • Ensure clarity
   • Fix errors

User Experience

1. Make It Searchable:

   • Enable search
   • Use keywords
   • Tag appropriately

2. Easy Navigation:

   • Clear categories
   • Logical order
   • Quick access

3. Mobile Friendly:

   • Responsive design
   • Touch-friendly
   • Readable on small screens

---

Troubleshooting

FAQ Not Displaying

Solutions:

1. Check status (must be Published)
2. Verify category is published
3. Clear cache
4. Check frontend settings

Search Not Working

Solutions:

1. Verify search is enabled
2. Check FAQ content
3. Clear cache
4. Test search functionality

Ordering Issues

Solutions:

1. Check display order values
2. Verify category settings
3. Clear cache
4. Re-save FAQs

---

Related Documentation

• Pages Module
• Knowledge Base Module
• General Settings

---

Last Updated: [Date will be updated during final review]