
Product Help Center
- 101 installs
- 73 repo stars
- Updated July 13, 2026
- vasilyu1983/ai-agents-public
Helps with ai & agent building tasks.
About
product-help-center is a Claude Code skill for ai & agent building. It helps solo builders move faster with AI-assisted development.
- product-help-center
- AI & Agent Building
- AI-coding skill
Product Help Center by the numbers
- 101 all-time installs (skills.sh)
- +9 installs in the week ending Aug 5, 2026 (Skillselion tracking)
- Ranked #4,345 of 16,546 AI & Agent Building skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/vasilyu1983/ai-agents-public --skill product-help-centerAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 101 |
|---|---|
| repo stars | ★ 73 |
| Last updated | July 13, 2026 |
| Repository | vasilyu1983/ai-agents-public ↗ |
What it does
Helps with ai & agent building tasks.
Files
Help Center Design
Design AI-first help centers, knowledge bases, FAQs, and learning materials.
This skill reflects the shift from static help portals to AI-powered, embedded, personalized self-service systems.
Workflow (Use As Default Order)
1. Define scope and constraints
- Audience/personas, product area(s), product versioning, channels (web/in-app), compliance requirements, localization needs.
2. Inventory current knowledge
- Top tickets, top searches, top articles, top escalation reasons, and known content owners.
3. Build information architecture
- Category structure, tagging, navigation, URL strategy, and internal linking.
4. Standardize content
- Article types, templates, AI-friendly writing rules, and visual standards.
5. Instrument and measure
- KPIs, event tracking, dashboards, and search query logging.
6. Add AI support safely
- Retrieval-first answers, citations, confidence thresholds, escalation rules, and transactional guardrails.
7. Run knowledge operations
- Governance, freshness detection, release-driven updates, and continuous optimization.
Expected outputs (adapt to request):
- Help center taxonomy map + tag schema
- Top 20 article backlog (by impact) + templates
- Analytics spec (events + dashboard KPIs)
- AI support spec (RAG sources, escalation thresholds, safety rules)
- Operating cadence (owners + review schedule)
Quick Reference
Content Type Decision Matrix
| User Need | Content Type | Format | AI Role |
|---|---|---|---|
| "How do I..." | How-To | Step-by-step | Suggest next steps |
| "Why isn't..." | Troubleshooting | Problem -> Cause -> Fix | Diagnose & resolve |
| "What is..." | Conceptual | Explanation | Summarize context |
| "Quick answer" | FAQ | Q&A pairs | Instant response |
| "Full specs" | Reference | Tables, lists | Search & retrieve |
| "Learn feature" | Tutorial | Video + interactive | Personalized path |
Platform Selection (Verify Pricing And Plan Limits)
| Company Stage | Platform | Monthly Cost | Best For |
|---|---|---|---|
| Enterprise | Zendesk | $55+/agent | Complex workflows, compliance |
| Growth/SaaS | Intercom | $29/seat + $0.99/resolution | Conversational, PLG |
| SMB/Startup | Freshdesk | $29-69/agent | Budget-friendly, native AI |
| Developer-focused | GitBook/Notion | $0-20/user | Docs-as-code |
See references/platform-guides.md for setup/migration notes and data/sources.json for curated comparison sources.
2025-2026 Best Practices
Key Shifts
| Aspect | Traditional (Pre-2024) | Modern (2025-2026) |
|---|---|---|
| Support model | Separate help portal | Embedded in-app help |
| AI role | Search assistant | Higher automation with safe escalation |
| Search | Keyword matching | Semantic + RAG |
| Content | Text-heavy articles | Visual-first (video, GIF, screenshots) |
| Personalization | Same for all users | By role, version, behavior |
| Maintenance | Manual curation | AI-driven freshness detection |
| Navigation | Category browsing | Conversational + contextual |
Avoid quoting hard statistics without verification; refresh trends and benchmarks via data/sources.json when needed.
AI-First Principles
1. Agentic Resolution — AI executes tasks (refunds, bookings, updates), not just answers 2. Semantic Understanding — Intent-based search, not keyword matching 3. Proactive Assistance — Surface help before users ask 4. Content Freshness — Auto-detect stale content, suggest updates 5. Multi-Source Synthesis — Pull from docs, tickets, Slack, release notes 6. Memory-Rich AI — Retain context across sessions for personalized support
Emerging Trends (2026)
| Trend | Description | Impact |
|---|---|---|
| Voice Search | Users speak instead of type to find information | Requires natural language KB content |
| Proactive AI | AI detects/resolves issues before users report | Reduces inbound support volume |
| Embedded Help | Help surfaces in-context, not separate portal | Higher engagement, lower friction |
| AI Operations Lead | New role supervising AI agent behavior | Shift from execution to oversight |
| Hallucination Mitigation | RAG grounding to reduce AI fabrication | Requires citation/source linking |
Help Center Architecture
Category Structure Rules
HIERARCHY LIMITS
- Maximum depth: 2-3 levels
- Top-level categories: 5-9 (cognitive load principle)
- Articles per category: 10-20 (scannable)
- Avoid: Deep nesting, internal org structureRecommended Top-Level Categories
STANDARD CATEGORIES (adapt to product)
1. Getting Started — First-run, setup, quick wins
2. [Core Feature 1] — Primary use case
3. [Core Feature 2] — Secondary use case
4. Account & Billing — Settings, payments, security
5. Integrations — Third-party connections
6. Troubleshooting — Common issues, error codes
7. API & Developers — Technical documentation
8. What's New — Changelog, releasesNavigation Patterns
- Breadcrumbs — Always show location in hierarchy
- Related Articles — 3-5 contextually relevant links
- Next Steps — Guide to logical next action
- Search Prominence — Above fold, always visible
- Popular Articles — Surface high-traffic content
Article Types (Keep The Set Small)
- How-To: task completion, 3-10 steps
- Troubleshooting: symptoms -> causes -> solutions
- FAQ: fast answers with links to deeper docs
- Conceptual: explain terms and mental models
- Reference: precise specs (tables, limits, error codes)
Use the copy-paste templates in references/article-templates.md.
AI Integration Patterns
Chatbot Architecture
MODERN AI SUPPORT FLOW (2025)
User query
-> Intent detection (semantic understanding)
-> RAG retrieval (KB + tickets + docs)
-> Response and action (answer and/or execute task)
-> Escalation check (confidence below threshold?)
-> Human agent (if needed)Agentic AI Capabilities (2025-2026)
| Capability | Example | Platform |
|---|---|---|
| Task execution | Process refund | Ada, Zendesk AI |
| Appointment booking | Schedule call | Chatbase, Calendly |
| Account updates | Change plan | Fin AI, custom |
| Ticket creation | Escalate to human | All platforms |
| Multi-system lookup | Check order + shipping | MCP integrations |
Content for AI Consumption
AI-FRIENDLY WRITING RULES
DO:
- Clear headings with keywords
- Structured data (tables, lists)
- Explicit step numbering
- Error messages verbatim
- Unique article titles
DON'T:
- Ambiguous pronouns
- Implicit assumptions
- Marketing fluff in support content
- Duplicate content across articlesSee references/ai-integration.md for RAG setup, evaluation, and escalation patterns.
Metrics & KPIs
Core Metrics
| Metric | Definition | Benchmark |
|---|---|---|
| Self-Service Rate | % issues resolved without agent | 60-80% |
| Deflection Rate | Tickets avoided via KB | 30-50% |
| Search Success | % searches -> helpful result | >70% |
| CSAT (KB) | Article helpfulness rating | >80% positive |
| Time to Resolution | Self-service completion time | <3 min |
| Zero-Result Rate | Searches with no results | <5% |
Content Health Metrics
FRESHNESS INDICATORS
- Last updated > 6 months -> Review required
- Last updated > 12 months -> Likely stale
- No views in 90 days -> Consider archive
- High bounce rate -> Content mismatch
QUALITY INDICATORS
- Thumbs down > 20% -> Rewrite needed
- Escalation after viewing -> Content gap
- Search -> immediate exit -> Title mismatchROI Calculation
SELF-SERVICE ROI FORMULA
Monthly Savings = (Deflected Tickets x $13) - Platform Cost
Example:
- 1,000 deflected tickets/month
- $13 average agent cost
- $500 platform cost
- ROI = ($13,000 - $500) = $12,500/monthSee references/metrics-optimization.md for instrumentation, dashboards, and optimization playbooks.
Learning & Onboarding
In-App Help Patterns
| Pattern | Use Case | Tools |
|---|---|---|
| Tooltips | Field-level guidance | Native, Appcues |
| Hotspots | Feature discovery | UserPilot, Pendo |
| Checklists | Onboarding progress | Whatfix, Chameleon |
| Tours | New feature intro | Intercom, Appcues |
| Contextual Help | Error recovery | Custom, Zendesk |
Tutorial Best Practices (2025)
VIDEO TUTORIALS
- Length: 2-4 minutes (40% higher completion)
- Format: Screen recording + voiceover
- Chapters: Clickable sections
- Captions: Always include (accessibility)
INTERACTIVE GUIDES
- Click-through walkthroughs
- Sandbox environments
- Progress saving
- Skip option for experienced usersSee references/learning-paths.md for onboarding sequence design, accessibility, and measurement.
Knowledge Operations (2026)
Operate the help center like a product:
- Assign owners per category and per top article; define review cadence and SLAs for updates.
- Use release notes, incident reports, and ticket trends as automatic triggers for content updates.
- Use freshness signals (search exits, escalation after article view, downvotes) to prioritize rewrites.
See references/knowledge-ops.md for governance, workflows, and checklists.
Implementation Checklist
Phase 1: Foundation (Week 1-2)
REQUIRED:
- Choose platform (Zendesk/Intercom/Freshdesk)
- Define category structure (5-9 top-level)
- Create article templates for each type
- Set up analytics tracking
- Configure search settings
Phase 2: Content (Week 3-4)
REQUIRED:
- Audit existing documentation
- Migrate/rewrite top 20 articles
- Add visual content (screenshots, GIFs)
- Implement internal linking
- Set up redirects from old URLs
Phase 3: AI Integration (Week 5-6)
REQUIRED:
- Enable AI chatbot
- Configure RAG/semantic search
- Set escalation thresholds
- Test common queries
- Monitor resolution rates
Phase 4: Optimization (Ongoing)
REQUIRED:
- Review zero-result searches weekly
- Update stale content monthly
- A/B test article titles
- Analyze escalation patterns
- Expand based on ticket trends
Resources
| Resource | Content |
|---|---|
| article-templates.md | Complete templates for all 5 article types |
| taxonomy-patterns.md | Category structures, tagging, search optimization |
| ai-integration.md | RAG setup, chatbot config, platform integrations |
| platform-guides.md | Zendesk, Intercom, Freshdesk, GitBook setup |
| learning-paths.md | Onboarding sequences, tutorial design, courses |
| metrics-optimization.md | KPI tracking, analytics, A/B testing |
| knowledge-ops.md | Governance, workflows, and operating cadence |
| content-migration-guide.md | Platform migration, URL redirects, content triage |
| multilingual-support.md | Translation workflows, glossary, RTL support |
| accessibility-standards.md | WCAG 2.2 AA for help content, audit checklist |
| sources.json | Curated sources with add_as_web_search flags |
Trend Awareness Protocol
REQUIRED: When users ask recommendation questions about help centers, knowledge bases, or support platforms, run a quick web search to confirm current trends before answering. Prefer sources flagged add_as_web_search: true in data/sources.json, plus official docs for any platform you recommend.
Trigger Conditions
- "What's the best help center platform?"
- "What should I use for [knowledge base/FAQ/support]?"
- "What's the latest in customer self-service?"
- "Current best practices for [AI support/chatbots]?"
- "Is [Zendesk/Intercom/Freshdesk] still relevant in 2026?"
- "[Zendesk] vs [Intercom] vs [other]?"
- "Best AI chatbot for customer support?"
Required Searches
1. Search: "help center best practices 2026" 2. Search: "[specific platform] vs alternatives 2026" 3. Search: "AI customer support trends January 2026" 4. Search: "knowledge base platforms 2026"
What to Report
After searching, provide:
- Current landscape: What support platforms/tools are popular NOW
- Emerging trends: New AI capabilities, patterns, or platforms gaining traction
- Deprecated/declining: Approaches or tools losing relevance
- Recommendation: Based on fresh data, not just static knowledge
If web search is unavailable, state that constraint and proceed with best-effort static guidance.
Example Topics (verify with fresh search)
- Help center platforms (Zendesk, Intercom, Freshdesk)
- AI support agents (Fin AI, Ada, Forethought)
- Knowledge base tools (Document360, GitBook, Notion)
- In-app guidance (UserPilot, Pendo, Chameleon)
- Self-service AI capabilities and resolution rates
- Semantic search and RAG for support
Fact-Checking
- Use web search/web fetch to verify current external facts, versions, pricing, deadlines, regulations, or platform behavior before final answers.
- Prefer primary sources; report source links and dates for volatile information.
- If web access is unavailable, state the limitation and mark guidance as unverified.
{
"metadata": {
"title": "Help Center Design - Sources",
"description": "Curated resources for AI-first help centers, knowledge bases, and self-service support (2025-2026)",
"last_updated": "2026-01-17",
"version": "1.1.0"
},
"platforms": [
{
"name": "Zendesk Guide Documentation",
"url": "https://support.zendesk.com/hc/en-us/categories/4405298743322-Guide-knowledge-base",
"description": "Official Zendesk knowledge base setup and best practices",
"add_as_web_search": false
},
{
"name": "Intercom Help Center",
"url": "https://www.intercom.com/help",
"description": "Intercom product documentation and help center examples",
"add_as_web_search": false
},
{
"name": "Freshdesk Knowledge Base",
"url": "https://support.freshdesk.com/",
"description": "Freshdesk support documentation and KB setup guides",
"add_as_web_search": false
},
{
"name": "GitBook Documentation",
"url": "https://docs.gitbook.com/",
"description": "GitBook docs-as-code platform documentation",
"add_as_web_search": false
},
{
"name": "Notion Help Center",
"url": "https://www.notion.so/help",
"description": "Notion as knowledge base platform",
"add_as_web_search": false
}
],
"ai_integration": [
{
"name": "Zendesk AI Knowledge Base Guide",
"url": "https://www.zendesk.com/service/help-center/ai-knowledge-base/",
"description": "AI-powered knowledge base features and setup",
"add_as_web_search": true
},
{
"name": "Intercom Fin AI",
"url": "https://fin.ai/",
"description": "Intercom's AI agent for customer service",
"add_as_web_search": true
},
{
"name": "Ada AI Customer Service",
"url": "https://www.ada.cx/",
"description": "AI-first customer service platform (83% resolution rate)",
"add_as_web_search": true
},
{
"name": "Chatbase AI Agents",
"url": "https://www.chatbase.co/",
"description": "Custom AI agents for customer service",
"add_as_web_search": true
},
{
"name": "OpenAI RAG and Semantic Search",
"url": "https://help.openai.com/en/articles/8868588-retrieval-augmented-generation-rag-and-semantic-search-for-gpts",
"description": "Official OpenAI guide on RAG and semantic search for GPTs",
"add_as_web_search": false
},
{
"name": "Azure AI Search RAG Overview",
"url": "https://learn.microsoft.com/en-us/azure/search/retrieval-augmented-generation-overview",
"description": "Microsoft's RAG implementation patterns",
"add_as_web_search": false
}
],
"best_practices_2025": [
{
"name": "Document360 KB Statistics 2025",
"url": "https://document360.com/blog/knowledge-base-statistics/",
"description": "Key knowledge base statistics and benchmarks for 2025",
"add_as_web_search": true
},
{
"name": "BetterDocs Future of Knowledge Bases",
"url": "https://betterdocs.co/future-of-knowledge-bases-trends/",
"description": "Knowledge base trends and predictions 2025-2026",
"add_as_web_search": true
},
{
"name": "Gainsight Self-Service Trends 2025",
"url": "https://www.gainsight.com/blog/the-future-of-digital-self-service-5-trends-to-watch-in-2025/",
"description": "Digital self-service trends and predictions",
"add_as_web_search": true
},
{
"name": "Help Scout Knowledge Base Guide",
"url": "https://www.helpscout.com/playlists/knowledge-base/",
"description": "Comprehensive guide to creating customer knowledge bases",
"add_as_web_search": false
},
{
"name": "Guidejar KB Best Practices 2025",
"url": "https://www.guidejar.com/blog/knowledge-base-best-practices",
"description": "8 knowledge base best practices that actually work",
"add_as_web_search": true
},
{
"name": "Khoros Customer Self-Service Guide 2025",
"url": "https://khoros.com/blog/customer-self-service",
"description": "Complete guide to customer self-service",
"add_as_web_search": true
}
],
"onboarding_tutorials": [
{
"name": "UserPilot Interactive Guides",
"url": "https://userpilot.com/blog/interactive-guides/",
"description": "How to create interactive guides for SaaS",
"add_as_web_search": true
},
{
"name": "UserPilot In-App Tutorials",
"url": "https://userpilot.com/blog/in-app-tutorials-adoption/",
"description": "Using in-app tutorials to increase product adoption",
"add_as_web_search": true
},
{
"name": "Whatfix Digital Adoption",
"url": "https://whatfix.com/",
"description": "Digital adoption platform for in-app guidance",
"add_as_web_search": false
},
{
"name": "Appcues Product-Led Growth",
"url": "https://www.appcues.com/",
"description": "User onboarding and product adoption platform",
"add_as_web_search": false
},
{
"name": "Pendo Product Analytics",
"url": "https://www.pendo.io/",
"description": "Product analytics and in-app guidance platform",
"add_as_web_search": false
},
{
"name": "eLearning Industry Interactive Tutorials",
"url": "https://elearningindustry.com/tips-create-interactive-immersive-online-training-tutorials",
"description": "Best practices for interactive online training",
"add_as_web_search": false
}
],
"analytics_metrics": [
{
"name": "Zendesk Customer Self-Service Portals",
"url": "https://www.zendesk.com/service/help-center/customer-self-service/",
"description": "Self-service portal best practices and metrics",
"add_as_web_search": true
},
{
"name": "ProProfs Knowledge Management Trends",
"url": "https://www.proprofskb.com/blog/trends-in-knowledge-base-management/",
"description": "Knowledge management trends and KPIs",
"add_as_web_search": true
},
{
"name": "Shelf Knowledge Management Trends 2025",
"url": "https://shelf.io/blog/the-9-knowledge-management-trends-you-can-expect-in-2025/",
"description": "9 knowledge management trends for 2025",
"add_as_web_search": true
}
],
"agentic_ai_2026": [
{
"name": "Gartner Agentic AI Prediction 2029",
"url": "https://www.gartner.com/en/newsroom/press-releases/2025-03-05-gartner-predicts-agentic-ai-will-autonomously-resolve-80-percent-of-common-customer-service-issues-without-human-intervention-by-20290",
"description": "Gartner predicts 80% autonomous customer service resolution by 2029",
"add_as_web_search": true
},
{
"name": "Forrester 2026 CX Predictions",
"url": "https://www.forrester.com/blogs/2026-the-year-ai-gets-real-for-customer-service-but-its-not-glamorous-work/",
"description": "Forrester predictions for AI in customer service 2026",
"add_as_web_search": true
},
{
"name": "Synthflow State of CX 2026",
"url": "https://synthflow.ai/blog/state-of-customer-experience-2026-ai-agents",
"description": "Cisco survey: 56% AI interactions by mid-2026, agentic AI trends",
"add_as_web_search": true
},
{
"name": "OneReach Agentic AI Stats 2026",
"url": "https://onereach.ai/blog/agentic-ai-adoption-rates-roi-market-trends/",
"description": "Agentic AI adoption rates, ROI, and market trends for 2026",
"add_as_web_search": true
},
{
"name": "Salesforce Proactive Service AI",
"url": "https://www.startuphub.ai/ai-news/ai-research/2026/salesforce-launches-proactive-customer-service-ai/",
"description": "Salesforce's proactive AI that detects and resolves issues before reported",
"add_as_web_search": true
},
{
"name": "Google Gemini Enterprise CX",
"url": "https://cloud.google.com/transform/a-new-era-agentic-commerce-retail-ai",
"description": "Google's agentic commerce platform for customer experience",
"add_as_web_search": true
}
],
"platform_comparisons": [
{
"name": "Intercom vs Zendesk vs Freshdesk 2026 - Qualimero",
"url": "https://qualimero.com/en/blog/intercom-vs-zendesk-vs-freshdesk-comparison-2026",
"description": "Comprehensive 2026 comparison with pricing warnings and use case analysis",
"add_as_web_search": true
},
{
"name": "Zendesk vs Intercom Comparison",
"url": "https://www.zendesk.com/service/comparison/zendesk-vs-intercom/",
"description": "Official Zendesk comparison with Intercom",
"add_as_web_search": true
},
{
"name": "Freshdesk vs Zendesk Comparison",
"url": "https://www.freshworks.com/freshdesk/compare-helpdesks/zendesk-vs-freshdesk/",
"description": "Freshdesk comparison with Zendesk",
"add_as_web_search": true
},
{
"name": "Zapier Zendesk vs Intercom 2025",
"url": "https://zapier.com/blog/zendesk-vs-intercom/",
"description": "Independent comparison of Zendesk and Intercom",
"add_as_web_search": true
},
{
"name": "Desk365 Best KB Software 2026",
"url": "https://www.desk365.io/blog/best-knowledge-base-software/",
"description": "9 best knowledge base software for 2026",
"add_as_web_search": true
},
{
"name": "Knowmax Best KB Software 2026",
"url": "https://knowmax.ai/knowledge-base/software/",
"description": "10 best knowledge base software in 2026",
"add_as_web_search": true
}
],
"rag_implementation": [
{
"name": "SearchUnify RAG Best Practices",
"url": "https://www.searchunify.com/resource-center/sudo-technical-blogs/best-practices-for-using-retrieval-augmented-generation-rag-in-ai-chatbots",
"description": "Best practices for RAG in AI chatbots",
"add_as_web_search": true
},
{
"name": "Botpress Build RAG Chatbot 2025",
"url": "https://botpress.com/blog/build-rag-chatbot",
"description": "How to build a RAG chatbot in 2025",
"add_as_web_search": true
},
{
"name": "ChatRAG Knowledge Base Guide",
"url": "https://chatrag.co/blog/chatbot-knowledge-base-the-complete-guide-to-building-smarter-ai-assistants",
"description": "Complete guide to RAG-powered AI assistants",
"add_as_web_search": true
},
{
"name": "Vercel AI SDK RAG Guide",
"url": "https://ai-sdk.dev/cookbook/guides/rag-chatbot",
"description": "Building RAG chatbots with Vercel AI SDK",
"add_as_web_search": false
},
{
"name": "n8n RAG Chatbot Tutorial",
"url": "https://blog.n8n.io/rag-chatbot/",
"description": "Build a custom knowledge RAG chatbot using n8n",
"add_as_web_search": false
}
],
"examples": [
{
"name": "Help Scout KB Examples",
"url": "https://www.helpscout.com/helpu/knowledge-base-examples/",
"description": "18 knowledge base examples that get it right",
"add_as_web_search": true
},
{
"name": "Slite KB Examples 2025",
"url": "https://slite.com/en/learn/knowledge-base-examples",
"description": "15 knowledge base examples to inspire you in 2025",
"add_as_web_search": true
},
{
"name": "Stripe Documentation",
"url": "https://docs.stripe.com/",
"description": "Example of excellent developer documentation",
"add_as_web_search": false
},
{
"name": "Notion Help Center Example",
"url": "https://www.notion.so/help",
"description": "Example of clean, searchable help center",
"add_as_web_search": false
}
]
}
Accessibility Standards
Accessibility requirements and operational checklists for help center content.
Contents
- WCAG 2.2 AA requirements for help centers
- Content structure
- Media accessibility
- Color and contrast
- Interactive elements
- Screen reader compatibility
- Testing tools
- Platform accessibility features
- Legal context
- Checklist: help center accessibility audit
- Do/Avoid
WCAG 2.2 AA Requirements for Help Centers
WCAG 2.2 AA is the standard to target. It covers perceivable, operable, understandable, and robust content.
Key criteria most relevant to help centers:
| WCAG Criterion | ID | What It Means for Help Centers |
|---|---|---|
| Non-text Content | 1.1.1 | All images need alt text |
| Captions (Prerecorded) | 1.2.2 | Videos need captions |
| Info and Relationships | 1.3.1 | Use semantic HTML (headings, lists, tables) |
| Contrast (Minimum) | 1.4.3 | 4.5:1 for text, 3:1 for large text |
| Resize Text | 1.4.4 | Content usable at 200% zoom |
| Keyboard | 2.1.1 | All functionality via keyboard |
| Focus Visible | 2.4.7 | Visible focus indicator on interactive elements |
| Headings and Labels | 2.4.6 | Descriptive headings that convey topic |
| Target Size | 2.5.8 | Minimum 24x24px for touch targets (new in 2.2) |
| Consistent Navigation | 3.2.3 | Navigation in same relative order across pages |
| Error Identification | 3.3.1 | Form errors clearly described |
| Parsing | 4.1.1 | Valid HTML |
Content Structure
Structure is the foundation of accessible help content.
HEADINGS
- Use one H1 per page (the article title)
- Follow heading hierarchy: H1 > H2 > H3 — never skip levels
- Make headings descriptive: "Reset your password" not "Step 2"
- Do not use bold text as a fake heading — use actual heading tags
LISTS
- Use ordered lists for sequential steps
- Use unordered lists for non-sequential items
- Do not use dashes or asterisks as visual bullets in plain text — use <ul>/<ol>
LINK TEXT
- Descriptive: "Read the billing FAQ" — not "click here"
- Unique: two different links on the same page should not both say "Learn more"
- Indicate when a link opens a new window or downloads a file
TABLES
- Use <th> for header cells with scope="col" or scope="row"
- Add a <caption> describing the table purpose
- Do not use tables for layout — only for tabular data
- Keep tables simple: avoid merged cells when possibleMedia Accessibility
IMAGES
- Every informational image needs alt text describing its content
- Decorative images: use alt="" (empty alt) so screen readers skip them
- Screenshots: describe the key element shown, not every pixel
Good: "Settings page with the Security tab highlighted"
Bad: "Screenshot" or "Image of the settings page showing the left sidebar with..."
- Do not embed text in images — screen readers cannot read it
VIDEO
- Provide captions for all video content (auto-captions need human review)
- Provide a text transcript as an alternative
- Do not autoplay video with sound
- Include audio descriptions if visual content is not conveyed by narration
AUDIO
- Provide a transcript for podcasts and audio content
- Ensure audio player controls are keyboard accessibleColor and Contrast
TEXT CONTRAST
- Normal text (<18px): minimum 4.5:1 contrast ratio against background
- Large text (18px+ or 14px+ bold): minimum 3:1 contrast ratio
- Use WebAIM Contrast Checker or browser DevTools to verify
COLOR AS INFORMATION
- Never use color alone to convey meaning
Bad: "Required fields are in red"
Good: "Required fields are marked with an asterisk (*) and red border"
- Status indicators need icon + color (not color only)
- Links must be distinguishable from body text by more than color
(underline or 3:1 contrast difference from surrounding text)
UI COMPONENTS
- Form input borders: minimum 3:1 contrast against background
- Focus indicators: minimum 3:1 contrast
- Buttons: text on button must meet contrast requirements
- Disabled elements: no contrast requirement, but avoid relying on themInteractive Elements
Help centers have search bars, navigation menus, feedback forms, and expandable sections. All must be keyboard accessible.
KEYBOARD ACCESSIBILITY
- Tab order follows visual reading order (left to right, top to bottom)
- All interactive elements reachable via Tab key
- Visible focus indicator on every focusable element
- Enter/Space activates buttons and links
- Escape closes modals, dropdowns, and overlays
- Arrow keys navigate within menus, tabs, and carousels
SEARCH
- Search input has a visible label or accessible name (aria-label)
- Search results announce count to screen readers
- Zero-result state is announced, not just visually displayed
- Autocomplete suggestions are navigable by keyboard
FORMS (feedback, contact)
- Every input has a visible <label> or aria-label
- Required fields indicated in label text (not just color)
- Error messages associated with the input via aria-describedby
- Error summary listed at top of form on submission failure
- Success confirmation announced to screen readers
EXPANDABLE/COLLAPSIBLE CONTENT (FAQ toggles, accordions)
- Use <button> with aria-expanded="true/false"
- Content region uses aria-controls linking to the content ID
- Keyboard: Enter/Space toggles open/closeScreen Reader Compatibility
SEMANTIC HTML
- Use <nav> for navigation
- Use <main> for primary content
- Use <aside> for sidebar
- Use <header> and <footer> for page header/footer
- Use <article> for self-contained content (each help article)
ARIA LANDMARKS
- Banner: <header role="banner"> (once per page)
- Navigation: <nav role="navigation" aria-label="Main">
- Main: <main role="main">
- Search: <form role="search">
- Complementary: <aside role="complementary">
- Content info: <footer role="contentinfo">
ARIA BEST PRACTICES
- Prefer native HTML elements over ARIA when possible
(<button> over <div role="button">)
- Use aria-label for elements without visible text
- Use aria-live="polite" for dynamic content updates (search results, notifications)
- Use aria-current="page" on the active navigation item
- Do not use aria-hidden="true" on visible contentTesting Tools
| Tool | Type | What It Catches | Cost |
|---|---|---|---|
| axe DevTools | Browser extension | Automated WCAG violations | Free (core) |
| WAVE | Browser extension | Visual accessibility overlay | Free |
| Lighthouse | Built into Chrome | Accessibility score + audit | Free |
| Pa11y | CLI / CI integration | Automated scanning, CI pipelines | Free (open source) |
| NVDA | Screen reader (Windows) | Real screen reader testing | Free |
| VoiceOver | Screen reader (macOS/iOS) | Real screen reader testing | Built-in |
| JAWS | Screen reader (Windows) | Enterprise screen reader testing | $90/yr |
| WebAIM Contrast Checker | Web tool | Color contrast ratios | Free |
TESTING PROCESS
1. Automated scan (axe or Lighthouse)
- Run on every page template (home, category, article, search results)
- Fix all Critical and Serious issues
- Automated tools catch ~30-40% of issues
2. Keyboard testing (manual)
- Tab through entire page — can you reach everything?
- Can you use search, navigation, and forms without a mouse?
- Is focus visible at all times?
3. Screen reader testing (manual)
- Test with VoiceOver (macOS) or NVDA (Windows)
- Navigate an article by headings — do they make sense?
- Read a how-to article — are steps clear without seeing the page?
- Submit a feedback form — are errors announced?
4. Zoom testing
- Zoom to 200% — is all content still usable?
- No horizontal scrolling at 320px viewport width (reflow)Platform Accessibility Features
ZENDESK GUIDE
- Copenhagen theme meets basic accessibility standards
- Customize with accessible color contrast
- Use built-in heading styles (do not override with custom CSS that breaks semantics)
- Article feedback widget is keyboard accessible
- Enable skip-to-content link in theme
INTERCOM
- Help Center articles render in semantic HTML
- Messenger widget supports keyboard navigation
- Fin AI responses are screen-reader compatible
- Custom themes: verify contrast and focus indicators
FRESHDESK
- Portal themes include basic accessibility
- Custom CSS: maintain focus indicators and contrast
- Knowledge base article editor outputs semantic HTML
- Test Freddy widget for keyboard access
GITBOOK
- Outputs semantic HTML by default
- Built-in dark mode and light mode
- Keyboard navigable sidebar and search
- Verify custom themes maintain accessibilityLegal Context
| Regulation | Jurisdiction | Applies To | Key Requirement |
|---|---|---|---|
| ADA Title III | United States | Public-facing websites | Accessible to people with disabilities; courts apply WCAG 2.1 AA |
| Section 508 | United States | Federal agencies and vendors | WCAG 2.0 AA (being updated to 2.1) |
| European Accessibility Act (EAA) | EU | Products and services sold in EU | WCAG 2.1 AA; enforcement from June 2025 |
| EN 301 549 | EU | ICT products and services | Harmonized standard for EU accessibility |
| AODA | Ontario, Canada | Organizations with 50+ employees | WCAG 2.0 AA |
| Equality Act 2010 | United Kingdom | Service providers | Reasonable adjustments for disabled users |
Practical guidance: target WCAG 2.2 AA. It satisfies all the above regulations and is the current best practice.
Checklist: Help Center Accessibility Audit
CONTENT
- [ ] All images have descriptive alt text (or empty alt for decorative)
- [ ] Videos have captions and transcripts
- [ ] Headings follow H1 > H2 > H3 hierarchy, no skipped levels
- [ ] Link text is descriptive (no "click here")
- [ ] Tables use <th> headers with scope
- [ ] No information conveyed by color alone
DESIGN
- [ ] Text contrast meets 4.5:1 (normal) and 3:1 (large)
- [ ] Focus indicators visible on all interactive elements
- [ ] Touch targets are at least 24x24px
- [ ] Content is usable at 200% zoom without horizontal scrolling
- [ ] Fonts are readable at default size (16px minimum body text)
INTERACTIVE
- [ ] All functionality accessible via keyboard
- [ ] Tab order matches visual order
- [ ] Search input has accessible label
- [ ] Form errors are announced and described
- [ ] Expandable sections use proper ARIA attributes
TECHNICAL
- [ ] Semantic HTML used (nav, main, article, header, footer)
- [ ] ARIA landmarks present and correct
- [ ] Language attribute set on <html> tag
- [ ] Page titles are unique and descriptive
- [ ] Skip-to-content link present
TESTING
- [ ] Automated scan (axe/Lighthouse) — zero Critical/Serious issues
- [ ] Keyboard-only navigation tested on all page types
- [ ] Screen reader tested on at least one article
- [ ] Mobile accessibility tested (touch, zoom, reflow)Do/Avoid
DO
- Write alt text that describes the purpose of the image, not just appearance
- Use native HTML elements before reaching for ARIA
- Test with real screen readers, not just automated tools
- Include accessibility in your content review checklist
- Set up automated accessibility scanning in CI/CD if using docs-as-code
- Train content authors on heading hierarchy and link text
AVOID
- Using images of text instead of actual text
- Removing focus outlines for aesthetic reasons
- Relying on placeholder text as the only label for form inputs
- Using "click here" or "read more" as link text
- Hiding content with display:none when it should be accessible
- Assuming automated tools catch all issues (they catch 30-40%)
- Treating accessibility as a one-time project instead of ongoing practiceAI Integration
AI chatbot architecture, RAG pipelines, and platform integrations for help centers.
Contents
- Modern AI Support Architecture (2025-2026)
- RAG Pipeline Design
- Semantic Search Setup
- AI-Friendly Content Writing
- Memory-Rich AI (2026 Trend)
- Agentic AI Capabilities
- Platform-Specific AI Setup
- Escalation & Handoff
- Monitoring & Optimization
Modern AI Support Architecture (2025-2026)
AI-First Support Flow
AI-FIRST SUPPORT FLOW (2025-2026)
User query
-> Intent classification (question vs task, topic, urgency)
-> Semantic search (RAG) (embedding, vector search, retrieval)
-> Response generation (answer, citations/links, confidence score)
If confidence is high: direct answer + sources
If confidence is medium: answer + "Was this helpful?"
If confidence is low: ask a clarifying question or escalateResolution Types
| Type | AI Action | Example |
|---|---|---|
| Informational | Answer from KB | "What are your pricing plans?" |
| Navigational | Link to resource | "Where do I find invoices?" |
| Transactional | Execute task | "Cancel my subscription" |
| Diagnostic | Troubleshoot | "Why isn't my export working?" |
| Escalation | Hand to human | "I want to speak to a manager" |
RAG Pipeline Design
Document Chunking Strategy
CHUNKING PARAMETERS
Chunk size: 500-1000 tokens (optimal for retrieval)
Overlap: 50-100 tokens (preserve context)
Boundaries: Respect section headers, paragraphs
CHUNKING METHODS
1. Fixed-size: Simple, consistent
2. Semantic: Split by meaning (paragraphs, sections)
3. Hierarchical: Parent-child relationships
RECOMMENDED: Semantic chunking with header preservation
EXAMPLE
Original article (2000 tokens):
- Chunk 1: Title + Intro (400 tokens)
- Chunk 2: Section 1 (500 tokens)
- Chunk 3: Section 2 (500 tokens)
- Chunk 4: Section 3 + Conclusion (600 tokens)
Metadata per chunk:
- article_id
- section_title
- position (1/4, 2/4, etc.)
- url
- last_updatedEmbedding Model Selection
| Model | Dimensions | Speed | Quality | Cost |
|---|---|---|---|---|
| OpenAI text-embedding-3-small | 1536 | Fast | Good | Low |
| OpenAI text-embedding-3-large | 3072 | Medium | Best | Medium |
| Cohere embed-v3 | 1024 | Fast | Good | Low |
| Voyage-2 | 1024 | Fast | Excellent | Medium |
| Local (e5-large-v2) | 1024 | Varies | Good | Free |
Recommendation: Start with text-embedding-3-small, upgrade if quality issues.
Vector Database Options
| Database | Best For | Managed Option |
|---|---|---|
| Pinecone | Production, scaling | Yes |
| Weaviate | Hybrid search | Yes (Cloud) |
| Qdrant | Self-hosted, filtering | Yes (Cloud) |
| Chroma | Prototyping, local | No |
| pgvector | PostgreSQL integration | Via Supabase |
Retrieval Configuration
RETRIEVAL PARAMETERS
Top-K: 3-5 chunks (balance relevance vs. context)
Similarity threshold: 0.7-0.8 (filter weak matches)
Reranking: Yes (improves precision)
HYBRID SEARCH (Recommended)
Combine:
1. Semantic search (70% weight) - meaning
2. Keyword search (30% weight) - exact matches
Benefits:
- Catches exact error messages
- Handles product names, codes
- Better coverage than semantic aloneContext Assembly
PROMPT TEMPLATE
You are a helpful support assistant for [Product].
Answer the user's question using ONLY the provided context.
If the context doesn't contain the answer, say so.
Always cite your sources.
Context:
---
{retrieved_chunks}
---
User Question: {query}
Instructions:
- Be concise and direct
- Use bullet points for steps
- Include relevant links
- If unsure, offer to connect with human supportSemantic Search Setup
Query Processing
QUERY ENHANCEMENT
1. Spell correction
"passowrd reset" -> "password reset"
2. Synonym expansion
"cost" -> "cost OR pricing OR price"
3. Query rewriting (LLM)
"it's not working" -> "troubleshooting [detected feature]"
4. Intent extraction
"how do I..." -> how-to intent
"why is..." -> troubleshooting intent
"what is..." -> conceptual intentSearch Result Ranking
RANKING SIGNALS
1. Vector similarity score (0.0-1.0)
2. Keyword match (BM25)
3. Recency boost (newer content)
4. Popularity (view count)
5. Manual boost (featured content)
COMBINED SCORE
final_score = (
0.5 * semantic_score +
0.3 * keyword_score +
0.1 * recency_score +
0.1 * popularity_score
)Handling Edge Cases
| Scenario | Detection | Response |
|---|---|---|
| Off-topic | Low similarity scores | "I can help with [Product] questions..." |
| Ambiguous | Multiple high-scoring topics | "Did you mean X or Y?" |
| No results | All scores < threshold | "I couldn't find info on that. Let me connect you..." |
| Outdated query | References old feature | "That feature is now called X..." |
AI-Friendly Content Writing
Structure for AI Consumption
CONTENT RULES FOR RAG
DO:
- Clear, keyword-rich headings
- One concept per paragraph
- Explicit step numbering
- Tables for structured data
- Exact error messages (searchable)
- FAQ format (question as heading)
DON'T:
- Ambiguous pronouns ("it", "this")
- Implicit assumptions
- Marketing fluff in support docs
- Information buried in paragraphs
- Duplicate content across articlesMetadata for AI
ARTICLE FRONTMATTER
---
title: How to Reset Your Password
description: Step-by-step guide to reset password via email or phone
keywords: [password, reset, forgot, login, access]
category: account/security
audience: all-users
difficulty: beginner
last_updated: 2025-01-15
related: [enable-2fa, account-recovery, login-issues]
---Answer Extraction Optimization
STRUCTURE FOR DIRECT ANSWERS
Bad (AI must parse):
"You can find your API key in several places.
One option is the dashboard. Another is the
settings page under API section."
Good (AI extracts easily):
"Find your API key:
1. Go to Settings > API
2. Click 'Reveal Key'
3. Copy the key
Alternative: Dashboard > Quick Actions > API Key"Memory-Rich AI (2026 Trend)
Unlike stateless chatbots, memory-rich AI retains context across sessions for faster, more personalized support.
Key Capabilities
MEMORY-RICH AI BENEFITS
1. Context Retention
- Remember previous conversations
- Track user preferences
- Recall past issues/resolutions
2. Personalization at Scale
- Tailored responses based on history
- Proactive suggestions from patterns
- Reduced "repeat yourself" frustration
3. Faster Resolution
- Skip re-identification steps
- Reference previous context
- Build on prior interactionsImplementation Pattern
MEMORY ARCHITECTURE
Session Start:
1. Retrieve user profile from CRM
2. Fetch last 5 conversation summaries from vector DB
3. Load relevant context into system prompt
During Conversation:
4. Store key facts extracted by LLM
5. Update preference signals
6. Track resolution outcomes
Session End:
7. Generate conversation summary
8. Store embeddings for future retrieval
9. Update user profile with new signals
STORAGE OPTIONS
- Short-term: Redis (session data, 24hr TTL)
- Long-term: Vector DB (conversation embeddings)
- Structured: PostgreSQL (user profiles, preferences)Memory Retrieval Query
# Example: Retrieve relevant past context
def get_user_memory(user_id: str, current_query: str, limit: int = 5):
# 1. Get user profile
profile = db.get_user_profile(user_id)
# 2. Semantic search past conversations
query_embedding = embed(current_query)
past_contexts = vector_db.search(
collection="conversations",
filter={"user_id": user_id},
vector=query_embedding,
limit=limit
)
# 3. Assemble memory context
return {
"profile": profile,
"past_interactions": past_contexts,
"preferences": profile.get("preferences", {})
}Agentic AI Capabilities
Task Execution (2025-2026)
AGENTIC ACTIONS
Level 1: Information retrieval
- Search knowledge base
- Summarize articles
- Provide links
Level 2: Simple actions
- Create support ticket
- Check order status
- Look up account info
Level 3: Transactional
- Process refund
- Cancel subscription
- Update account details
Level 4: Complex workflows
- Book appointment
- Escalate with context
- Multi-system lookupTool Integration (Function Calling)
TOOL DEFINITIONS (Example)
tools = [
{
"name": "check_order_status",
"description": "Check the status of a customer order",
"parameters": {
"order_id": {"type": "string", "required": True}
}
},
{
"name": "process_refund",
"description": "Process a refund for an order",
"parameters": {
"order_id": {"type": "string", "required": True},
"reason": {"type": "string", "required": True},
"amount": {"type": "number", "required": False}
}
},
{
"name": "create_ticket",
"description": "Create a support ticket for human review",
"parameters": {
"subject": {"type": "string", "required": True},
"description": {"type": "string", "required": True},
"priority": {"type": "string", "enum": ["low", "medium", "high"]}
}
}
]Model Context Protocol (MCP)
MCP INTEGRATION (2025)
Purpose: Standardized protocol for AI-to-tool communication
Benefits:
- Plug-and-play tool connections
- Consistent authentication
- Built-in safety guardrails
Use cases:
- Connect AI to CRM (Salesforce, HubSpot)
- Access order management systems
- Query internal databases
- Trigger workflow automationPlatform-Specific AI Setup
Zendesk AI
ZENDESK AI FEATURES
1. Answer Bot
- Suggests articles during ticket creation
- Auto-resolve common questions
- Learns from agent responses
2. Generative AI (2024+)
- Draft article summaries
- Suggest article updates
- Tone adjustment
3. Intelligent Triage
- Auto-categorize tickets
- Priority prediction
- Agent routing
SETUP STEPS
1. Enable AI in Admin > AI > Bots
2. Train on knowledge base
3. Set confidence thresholds
4. Configure escalation rules
5. Monitor resolution ratesIntercom Fin AI
FIN AI FEATURES
1. Resolution
- Answers from your content
- Multi-turn conversations
- Task execution (with tools)
2. Sources
- Help Center articles
- Website content
- Custom data sources
3. Behavior
- Customizable persona
- Handoff rules
- Business hours
PRICING
$0.99 per resolution
Resolution = AI successfully answers without human
SETUP STEPS
1. Install Fin (Settings > Fin)
2. Connect content sources
3. Test in Sandbox
4. Set live traffic %
5. Monitor Fin reportsFreshdesk Freddy AI
FREDDY AI FEATURES
1. Auto-suggest
- Canned responses
- Solution articles
- Similar tickets
2. Ticket classification
- Category prediction
- Priority assignment
- Group routing
3. Customer-facing bot
- Self-service answers
- Ticket deflection
- Agent handoff
INCLUDED IN: Pro ($49) and Enterprise plans
SETUP STEPS
1. Admin > Freddy > Enable
2. Train on ticket history
3. Configure bot flows
4. Set escalation triggers
5. Review suggestions qualityCustom AI Implementation
BUILD YOUR OWN (Stack)
Frontend:
- Chat widget (custom or open-source)
- WebSocket for real-time
Backend:
- FastAPI / Node.js
- Message queue (Redis)
- Session management
AI Layer:
- LLM (Claude, GPT-4, Llama)
- RAG pipeline
- Function calling
Vector DB:
- Pinecone / Qdrant / pgvector
Integrations:
- Helpdesk API (tickets)
- CRM API (customer data)
- Webhooks (notifications)Escalation & Handoff
Escalation Triggers
AUTO-ESCALATE WHEN
Confidence-based:
- AI confidence < 0.5
- Multiple failed attempts (>2)
- User frustration detected
Content-based:
- Billing disputes
- Legal/compliance
- Security incidents
- VIP customers
Explicit:
- User requests human
- Keywords: "speak to agent", "manager"Handoff Best Practices
SEAMLESS HANDOFF
1. Context transfer
- Full conversation history
- AI's attempted answers
- Detected intent
- Customer info
2. Warm introduction
"[Agent name] will continue helping you.
I've shared our conversation so you won't
need to repeat anything."
3. No dead ends
- Always offer alternative if no agents
- Callback option
- Email follow-upHuman-AI Collaboration
AGENT ASSIST FEATURES
1. Suggested responses
- Based on conversation context
- From knowledge base
- From similar resolved tickets
2. Real-time guidance
- Policy reminders
- Upsell opportunities
- Compliance warnings
3. Auto-summarization
- Ticket summary after resolution
- Key points extraction
- Follow-up suggestionsMonitoring & Optimization
AI Performance Metrics
| Metric | Definition | Target |
|---|---|---|
| Resolution rate | % resolved without human | 60-80% |
| Containment rate | % stayed in AI flow | 70-85% |
| Accuracy | Correct answers (sampled) | >90% |
| CSAT (AI) | User satisfaction with AI | >75% |
| Escalation rate | % transferred to human | 15-30% |
| Avg. turns to resolution | Conversation length | <4 |
Quality Assurance
AI QA PROCESS
Weekly:
- Review 50 random AI conversations
- Check accuracy of answers
- Identify hallucinations
- Flag edge cases
Monthly:
- Update content gaps found
- Retrain on new content
- Adjust confidence thresholds
- Review escalation patterns
Quarterly:
- Full accuracy audit
- Benchmark against competitors
- User satisfaction survey
- Cost-benefit analysisContinuous Improvement
FEEDBACK LOOP
1. Collect signals
- Thumbs up/down
- "Was this helpful?"
- Escalation after AI answer
- User corrections
2. Analyze patterns
- Common failure modes
- Missing content topics
- Misunderstood queries
3. Improve
- Add/update content
- Tune prompts
- Adjust thresholds
- Add synonymsArticle Templates
Copy-paste templates for all help center article types.
Contents
- How-To article template
- Troubleshooting article template
- Conceptual article template
- FAQ article template
- Reference article template
- Video tutorial script template
- Production checklist
- Visual content guidelines
How-To Article Template
# How to [Action Verb] [Object]
[1-2 sentence intro explaining what this guide covers and the outcome]
## Prerequisites
- [Requirement 1 - e.g., Admin access required]
- [Requirement 2 - e.g., Feature enabled in Settings]
- [Requirement 3 - optional, link to setup guide]
## Steps
### Step 1: [Action verb + specific action]
[2-3 sentences explaining what to do]

*Caption: What the user should see*
### Step 2: [Action verb + specific action]
[Instructions]
> **Note**: [Important callout if needed]
### Step 3: [Action verb + specific action]
[Instructions]
Code block if relevant
## Result
[Describe what success looks like - what the user should see/experience]

## Troubleshooting
| Issue | Solution |
|-------|----------|
| [Common problem 1] | [Quick fix] |
| [Common problem 2] | [Quick fix or link] |
## Next Steps
- [Related task 1](link)
- [Related task 2](link)
- [Advanced guide](link)
---
**Was this helpful?** [Yes] [No]
*Last updated: YYYY-MM-DD*How-To Writing Guidelines
| Element | Rule |
|---|---|
| Title | Start with "How to" + action verb |
| Steps | 3-7 steps ideal, max 10 |
| Screenshots | One per major step |
| Prerequisites | List all blockers upfront |
| Result | Always show success state |
Troubleshooting Article Template
# Fix: [Error Message or Problem Description]
[Brief description of the issue and its impact]
## Symptoms
- [What the user sees - exact error text]
- [Related behavior]
- [When it typically occurs]
**Error Message:**[Exact error text user sees]
## Quick Fixes
Try these solutions in order:
### 1. [Most common solution]
**Why this works**: [Brief explanation]
**Steps:**
1. [Step 1]
2. [Step 2]
3. [Step 3]
**Expected result**: [What should happen]
---
### 2. [Second most common solution]
**Why this works**: [Brief explanation]
**Steps:**
1. [Step 1]
2. [Step 2]
---
### 3. [Edge case solution]
**When to try**: [Specific condition]
**Steps:**
1. [Step 1]
2. [Step 2]
## Root Causes
| Cause | Likelihood | Solution |
|-------|------------|----------|
| [Cause 1] | Common | Solution 1 above |
| [Cause 2] | Occasional | Solution 2 above |
| [Cause 3] | Rare | Contact support |
## Prevention
- [How to avoid this in the future]
- [Best practice recommendation]
## Still Not Working?
If none of the solutions above resolved your issue:
1. **Gather this information:**
- Browser/app version
- Steps to reproduce
- Screenshot of error
2. **Contact support:**
[Contact Support](link) — Average response: [X hours]
---
**Was this helpful?** [Yes] [No]
*Last updated: YYYY-MM-DD*Troubleshooting Writing Guidelines
| Element | Rule |
|---|---|
| Title | "Fix:" prefix or exact error message |
| Solutions | Most common first (80/20 rule) |
| Error text | Include exact message for search |
| Escalation | Always provide escape path |
Conceptual Article Template
# [Concept Name]: [Brief Description]
[2-3 sentence overview explaining what this is and why it matters]
## What is [Concept]?
[Clear definition in plain language, 2-4 sentences]
### Key Points
- [Essential point 1]
- [Essential point 2]
- [Essential point 3]
## How [Concept] Works
[Explanation with diagram or visual if helpful]
[Simple diagram using ASCII or embedded image]
### Components
| Component | Purpose | Example |
|-----------|---------|---------|
| [Part 1] | [What it does] | [Concrete example] |
| [Part 2] | [What it does] | [Concrete example] |
| [Part 3] | [What it does] | [Concrete example] |
## When to Use [Concept]
**Use when:**
- [Scenario 1]
- [Scenario 2]
**Don't use when:**
- [Anti-pattern 1]
- [Alternative approach]
## Examples
### Example 1: [Common use case]
[Concrete example with before/after or input/output]
### Example 2: [Advanced use case]
[Second example showing more complex application]
## Related Concepts
- **[Related concept 1]**: [How it relates](link)
- **[Related concept 2]**: [How it relates](link)
## Learn More
- [How-to guide using this concept](link)
- [Advanced documentation](link)
- [Video tutorial](link)
---
**Was this helpful?** [Yes] [No]
*Last updated: YYYY-MM-DD*FAQ Article Template
# [Topic] FAQs
Frequently asked questions about [topic].
---
## Getting Started
<details>
<summary><strong>Q: [Question in natural language]?</strong></summary>
[Answer in 2-4 sentences]
[Link to detailed guide if needed](link)
</details>
<details>
<summary><strong>Q: [Question 2]?</strong></summary>
[Answer]
</details>
---
## [Category 2]
<details>
<summary><strong>Q: [Question]?</strong></summary>
[Answer]
| Option | Result |
|--------|--------|
| [A] | [What happens] |
| [B] | [What happens] |
</details>
<details>
<summary><strong>Q: [Question]?</strong></summary>
[Answer]
> **Tip**: [Helpful additional info]
</details>
---
## Billing & Account
<details>
<summary><strong>Q: [Billing question]?</strong></summary>
[Answer]
**Related**: [Billing settings](link)
</details>
---
## Troubleshooting
<details>
<summary><strong>Q: Why am I seeing [error]?</strong></summary>
This usually happens when [cause].
**Quick fix:**
1. [Step 1]
2. [Step 2]
**Still not working?** [Contact support](link)
</details>
---
**Can't find your answer?**
- [Search help center](link)
- [Contact support](link)
- [Community forum](link)
*Last updated: YYYY-MM-DD*FAQ Writing Guidelines
| Element | Rule |
|---|---|
| Questions | Natural language (how users actually ask) |
| Answers | 2-4 sentences max, link to detail |
| Grouping | By topic, 5-8 questions per group |
| Format | Collapsible for scannability |
Reference Article Template
# [Feature/API] Reference
Complete reference for [feature/API name].
## Overview
| Property | Value |
|----------|-------|
| **Availability** | [Plan tier] |
| **API Endpoint** | `[endpoint]` |
| **Rate Limit** | [X requests/minute] |
| **Last Updated** | [Date] |
## Parameters
### Required Parameters
| Parameter | Type | Description |
|-----------|------|-------------|
| `param1` | string | [Description] |
| `param2` | integer | [Description] |
### Optional Parameters
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `option1` | boolean | `false` | [Description] |
| `option2` | string | `null` | [Description] |
## Examples
### Basic Usage
{ "param1": "value", "param2": 123 }
**Response:**
{ "status": "success", "data": { ... } }
### Advanced Usage
{ "param1": "value", "param2": 123, "option1": true }
## Error Codes
| Code | Message | Cause | Solution |
|------|---------|-------|----------|
| 400 | Invalid parameter | [Cause] | [Fix] |
| 401 | Unauthorized | [Cause] | [Fix] |
| 429 | Rate limited | [Cause] | [Fix] |
## Limits & Quotas
| Limit | Free | Pro | Enterprise |
|-------|------|-----|------------|
| [Limit 1] | [Value] | [Value] | [Value] |
| [Limit 2] | [Value] | [Value] | Unlimited |
## Changelog
| Date | Change |
|------|--------|
| YYYY-MM-DD | [Change description] |
| YYYY-MM-DD | [Change description] |
## Related
- [API Authentication](link)
- [Webhooks Reference](link)
- [SDK Documentation](link)
---
*Last updated: YYYY-MM-DD*Video Tutorial Script Template
# Video: How to [Action]
**Duration**: [X:XX]
**Skill Level**: [Beginner/Intermediate/Advanced]
## Script
### Intro (0:00-0:15)
"In this video, you'll learn how to [outcome]. By the end, you'll be able to [specific skill]."
### Section 1: [Topic] (0:15-1:00)
**Visuals**: [Screen recording of X]
"First, let's [action]. Navigate to [location]..."
**Key Points to Show**:
- [ ] [Visual element 1]
- [ ] [Visual element 2]
### Section 2: [Topic] (1:00-2:00)
**Visuals**: [Screen recording of Y]
"Now that we've [previous action], let's [next action]..."
### Section 3: [Topic] (2:00-3:00)
**Visuals**: [Result/confirmation screen]
"You've successfully [outcome]. Here's what you should see..."
### Outro (3:00-3:30)
"That's how you [action]. For more help, check the links in the description. If you found this helpful, [CTA]."
## Production Checklist
- [ ] Script approved
- [ ] Screen recording captured
- [ ] Voiceover recorded
- [ ] Captions added
- [ ] Thumbnail created
- [ ] Chapter markers set
- [ ] Description with links
- [ ] Published to: [platforms]
## Metadata
**Title**: How to [Action] | [Product Name]
**Description**: Learn how to [action] in [time]. This tutorial covers [topics]. Timestamps: [chapters]
**Tags**: [tag1], [tag2], [tag3]
**Thumbnail**: [Description]Content Quality Checklist
Before Publishing
QUALITY GATES
[ ] Title matches search intent
[ ] Intro answers "what will I learn?"
[ ] Steps are numbered and actionable
[ ] Screenshots are current (check version)
[ ] Links work (test all)
[ ] Mobile-friendly formatting
[ ] Accessibility: alt text, captions
[ ] Related articles linked
[ ] Feedback mechanism present
[ ] Last updated date set
AI-FRIENDLY CHECKS
[ ] Clear headings with keywords
[ ] No ambiguous pronouns
[ ] Error messages exact (for search)
[ ] No duplicate content elsewhere
[ ] Structured data (tables, lists)Content Review Schedule
| Content Type | Review Frequency | Trigger |
|---|---|---|
| How-To | Quarterly | Feature update |
| Troubleshooting | Monthly | New errors reported |
| FAQ | Monthly | Ticket trends |
| Reference | On release | API/feature change |
| Conceptual | Bi-annually | Architecture change |
Visual Content Guidelines
Screenshots
SCREENSHOT REQUIREMENTS
Size: 1200x800px minimum (2x for retina)
Format: PNG for UI, GIF for sequences
Annotations:
- Red boxes for emphasis
- Numbered callouts for steps
- Blur sensitive data
File naming: [article-slug]-step-[N].pngGIF Recordings
GIF GUIDELINES
Duration: 5-15 seconds
Frame rate: 10-15 fps
Size: Under 5MB
Tools: CleanShot, Kap, LICEcap
Use for: Multi-step actions, hover statesDiagrams
DIAGRAM TYPES
Flowcharts: Decision processes
Architecture: System overviews
Timelines: Sequences, processes
Comparison: Feature matrices
Tools: Excalidraw, Mermaid, Whimsical
Style: Consistent colors, minimal textContent Migration Guide
Patterns and checklists for migrating help center content between platforms or during redesigns.
Contents
- Migration triggers
- Pre-migration audit
- Content triage matrix
- URL redirect strategy
- Migration phases
- Platform export/import
- SEO preservation
- Post-migration validation
- Rollback plan
- Timeline template
- Do/Avoid
Migration Triggers
Common reasons to migrate:
| Trigger | Urgency | Typical Complexity |
|---|---|---|
| Platform change (e.g., Zendesk to Intercom) | Medium | High |
| Help center redesign or IA overhaul | Low | Medium |
| Company acquisition or merger | High | High |
| Rebrand (name, domain, or visual identity) | Medium | Medium |
| Platform pricing change or sunset | High | High |
| Consolidating multiple help centers into one | Medium | High |
Rule: never migrate and redesign at the same time. Migrate first, redesign after baseline metrics stabilize.
Pre-Migration Audit
Before touching content, build a complete inventory.
AUDIT CHECKLIST
1. Content inventory
- Export full article list with metadata (title, URL, category, author, last updated)
- Record article count per category
- Flag draft/unpublished articles
2. Traffic data
- Export 90-day page views per article (GA4 or platform analytics)
- Identify top 50 articles by traffic
- Identify bottom 20% (candidates for archive/delete)
3. Link health
- Run broken link scan (Screaming Frog, Ahrefs, or platform tool)
- Document internal cross-links between articles
- List external sites linking to your help center (Ahrefs, Search Console)
4. Content quality
- Pull helpfulness ratings per article
- Flag articles not updated in 12+ months
- Flag articles with negative feedback trendsContent Triage Matrix
Score every article before migration. Do not migrate garbage.
| Decision | Criteria | Action |
|---|---|---|
| Migrate as-is | High traffic, positive ratings, current content | Copy to new platform, preserve URL |
| Rewrite | High traffic but outdated or low-rated | Rewrite before or immediately after migration |
| Merge | Multiple articles covering the same topic | Consolidate into one, redirect old URLs |
| Archive | Low traffic, still accurate, niche audience | Move to archive category, keep URL alive |
| Delete | Zero traffic, outdated, no inbound links | Remove, set up 301 to nearest relevant article |
Priority order: migrate high-traffic articles first, then work down the triage list.
URL Redirect Strategy
Every old URL must resolve. Broken links destroy SEO and user trust.
REDIRECT RULES
1. Build a redirect map spreadsheet
Columns: old_url | new_url | redirect_type | status | verified
2. Redirect types
- 301 (permanent): default for all migrations
- 302 (temporary): only during staged rollout or A/B testing
3. Wildcard redirects
- Use for entire category moves: /old-category/* -> /new-category/*
- Test wildcards thoroughly — bad patterns break unrelated pages
4. Testing
- Crawl all old URLs and verify 301 response
- Spot-check top 50 articles manually
- Verify redirect chains are max 1 hop (no chains of 301 -> 301 -> 301)
5. Monitoring
- Set up 404 monitoring post-launch (GA4, Search Console, platform alerts)
- Review 404 report daily for first 2 weeksMigration Phases
PHASE 1: AUDIT (Week 1)
- Complete content inventory
- Pull traffic and quality data
- Run broken link scan
- Document external inbound links
PHASE 2: TRIAGE (Week 2)
- Apply triage matrix to every article
- Get stakeholder sign-off on delete/archive decisions
- Identify articles needing rewrite
PHASE 3: MAP REDIRECTS (Week 2-3)
- Build redirect map spreadsheet
- Define new URL structure
- Set up wildcard rules
- Peer-review redirect map
PHASE 4: MIGRATE (Week 3-4)
- Export from old platform
- Import to new platform (API or CSV)
- Re-upload images and attachments
- Apply new templates and formatting
- Restore internal cross-links
PHASE 5: QA (Week 5)
- Crawl all new URLs
- Test redirects from old URLs
- Verify images, videos, embedded content
- Check search index on new platform
- Test on mobile and screen readers
- Validate analytics tracking fires
PHASE 6: LAUNCH (Week 6)
- Switch DNS or publish new help center
- Submit updated sitemap to Search Console
- Monitor 404s and traffic daily
- Communicate change to support teamPlatform Export/Import
| Platform | Export Method | Format | Notes |
|---|---|---|---|
| Zendesk Guide | Admin > Guide > CSV export; or API | CSV, JSON via API | API preserves metadata and attachments |
| Intercom | Settings > Help Center > Export; or API | CSV, JSON via API | No native bulk image export — use API |
| Freshdesk | Admin > Knowledge Base > Export | CSV | Tags and categories export separately |
| Confluence | Space tools > Content tools > Export | XML, HTML, PDF | XML preserves structure best |
| Notion | Settings > Export | HTML, Markdown | Markdown loses some formatting |
| GitBook | Git repo clone | Markdown | Cleanest export for docs-as-code workflows |
Import tip: always do a test import with 10-20 articles before running the full batch. Validate formatting, images, and metadata.
SEO Preservation
SEO CHECKLIST
1. Canonical URLs
- Set canonical tags on all new articles
- Remove canonical tags from old platform (or shut it down)
2. Sitemap
- Generate and submit new sitemap to Google Search Console
- Remove old sitemap
- Verify new sitemap is indexed (Search Console > Sitemaps)
3. Google Search Console
- Add new property if domain changed
- Use Change of Address tool if moving domains
- Monitor Index Coverage report for errors
- Monitor Core Web Vitals on new platform
4. Structured data
- Preserve or add FAQ schema, HowTo schema, Breadcrumb schema
- Test with Google Rich Results Test
5. Meta tags
- Migrate title tags and meta descriptions
- Do not let the new platform auto-generate generic descriptionsPost-Migration Validation
VALIDATION CHECKLIST (run within 48 hours of launch)
Content integrity:
- [ ] Article count matches expected (migrated + new - deleted)
- [ ] All images and attachments load
- [ ] Embedded videos play
- [ ] Code blocks render correctly
- [ ] Tables display properly on mobile
Links and navigation:
- [ ] Internal cross-links resolve
- [ ] Old URLs redirect (spot-check top 50)
- [ ] Breadcrumbs show correct hierarchy
- [ ] Search returns results for top 20 queries
SEO and analytics:
- [ ] Sitemap submitted and indexed
- [ ] Analytics tracking fires on all pages
- [ ] 404 error rate below 1% of traffic
- [ ] Google Search Console shows no new crawl errors
Functional:
- [ ] Search works (test 10 common queries)
- [ ] Feedback widget works
- [ ] Contact/escalation links work
- [ ] AI chatbot (if any) pulls from new contentRollback Plan
Never migrate without a fallback.
ROLLBACK STRATEGY
1. Keep old platform running in parallel for 30-90 days
- Read-only mode is fine
- Do not delete old content until new platform is stable
2. DNS rollback
- Document exact DNS changes made
- Test DNS revert in staging before launch
- Keep old SSL certificate valid
3. Rollback triggers
- 404 rate exceeds 5% of traffic for 24+ hours
- Search index not picked up after 7 days
- Critical content missing with no backup
- Platform outage on new provider lasting 4+ hours
4. Communication plan
- Notify support team immediately on rollback
- Post status page update if customer-facingTimeline Template: 6-Week Migration
| Week | Phase | Key Deliverables |
|---|---|---|
| 1 | Audit | Content inventory, traffic data, link audit |
| 2 | Triage + redirect mapping | Triage decisions, redirect spreadsheet |
| 3 | Migrate (batch 1) | Top 50 articles migrated, images uploaded |
| 4 | Migrate (batch 2) | Remaining articles, cross-links restored |
| 5 | QA | Full crawl, redirect testing, analytics verified |
| 6 | Launch + monitor | DNS switch, sitemap submitted, daily 404 review |
Adjust timeline based on article count. Under 100 articles: compress to 3-4 weeks. Over 500 articles: extend to 8-10 weeks.
Do/Avoid
DO
- Build the redirect map before migrating anything
- Test-import a small batch first
- Preserve URL slugs where possible
- Monitor 404s daily for the first 2 weeks
- Keep the old platform alive as a rollback
- Communicate the migration timeline to the support team
AVOID
- Migrating and redesigning simultaneously
- Deleting old platform before validating the new one
- Skipping the content triage (migrating junk wastes effort)
- Using 302 redirects when you mean 301
- Relying solely on wildcard redirects without testing
- Ignoring external inbound links (they carry SEO value)
- Launching on a FridayKnowledge Operations
Governance and operating cadence for maintaining a high-quality, AI-ready help center over time.
Contents
- Governance model
- Content lifecycle
- Freshness and quality signals
- Release and incident integration
- Localization and accessibility
- AI support alignment
- Operating cadence
Governance Model
Define clear ownership so content stays correct, current, and safe.
Recommended roles:
- Help center owner (program owner, prioritization, standards)
- Support operations (tooling, workflows, reporting)
- Product SMEs (technical correctness)
- Legal/security reviewer (when required)
- Writers/editors (clarity, consistency, UX)
Assign ownership at two levels:
- Category owner: responsible for taxonomy area health
- Top-article owner: responsible for the highest-impact articles in that area
Content Lifecycle
Use a consistent lifecycle to avoid drift:
1. Intake
- Sources: tickets, search logs, escalations, release notes, incidents.
2. Draft
- Use standard templates and AI-friendly writing rules.
3. Review
- SME approval for correctness; legal/security review when needed.
4. Publish
- Ensure correct IA placement, tags, and internal links.
5. Measure
- Track helpfulness, search success, and escalation after reading.
6. Improve
- Rewrite titles, add visuals, and fix missing prerequisites.
7. Retire
- Redirect obsolete URLs; archive deprecated content with rationale.
Freshness And Quality Signals
Use both time-based and behavior-based signals.
Freshness signals:
- Product releases affecting a feature referenced in the article
- Broken links, outdated screenshots, or changed UI labels
- Article not updated in 6-12 months (threshold depends on release cadence)
Behavior signals:
- High search-to-exit rate (users give up after searching)
- High escalation rate after article view (content does not resolve the issue)
- High negative feedback rate (thumbs down, low rating)
- High repeat view rate for the same issue (users need multiple passes)
Prioritization heuristic:
- Fix the smallest number of articles that deflect the largest number of tickets.
Release And Incident Integration
Make content updates a standard part of delivery:
- For every release that changes UI/workflows, update impacted how-to and troubleshooting articles.
- For every incident, publish:
- "Status and workaround" article (during incident)
- Post-incident explanation and prevention guidance (after incident)
- Keep a "What's New" category that is also used as a freshness trigger for AI retrieval.
Localization And Accessibility
Localization:
- Maintain a glossary for product terms and translated UI labels.
- Prefer text instructions over images with embedded text.
- Track translation coverage for the top traffic articles first.
Accessibility:
- Add alt text for images and captions for videos.
- Use headings and lists for structure; avoid conveying meaning by color only.
- Keep steps scannable and avoid long paragraphs.
AI Support Alignment
Keep the help center retrieval-friendly:
- Use unique, intent-rich titles.
- Keep error messages verbatim and in dedicated blocks.
- Add metadata where the platform supports it (product area, audience, plan tier, version, last_updated).
- Prefer explicit prerequisites and explicit success criteria.
Define AI answer safety rules:
- Require citations/links for factual answers and procedures.
- Ask clarifying questions when plan tier, role, or product version affects the steps.
- Escalate for billing disputes, account security, legal/compliance, and low confidence.
- For transactional requests, require explicit confirmation before irreversible actions.
Maintain an evaluation set for AI and search:
- Top 50 searches and their expected destination article(s)
- Top 50 tickets and the minimum viable "self-service answer"
- A set of failure-mode queries (ambiguous, missing context, policy-sensitive)
Operating Cadence
Weekly:
- Review top zero-result searches and add/retitle content.
- Review "high traffic + low helpfulness" articles and rewrite one batch.
- Audit AI escalations to identify content gaps and safety failures.
Monthly:
- Refresh screenshots and UI labels for the highest traffic categories.
- Review top deflection opportunities from ticket tags.
- Validate analytics event coverage and dashboard health.
Quarterly:
- Taxonomy audit (category sprawl, duplicates, broken navigation).
- Content pruning and redirect cleanup.
- Governance review (owners, SLAs, escalation playbooks).
Learning Paths
Onboarding sequences, tutorial design, and course structure for product education.
Contents
- Onboarding Design Principles (2025)
- Onboarding Sequences
- Tutorial Design
- In-App Help Patterns
- Course Structure
- Tools & Platforms
- Metrics & Optimization
- Accessibility
Onboarding Design Principles (2025)
Modern Onboarding Philosophy
SHIFT FROM -> TO
Linear tours -> User-driven journeys
Feature dumps -> Value-first moments
One-size-fits-all -> Personalized paths
Separate help center -> Embedded contextual help
Completion focus -> Activation focusActivation-Focused Onboarding
ACTIVATION FRAMEWORK
1. Define "Aha Moment"
- What makes users stick?
- First value experience
- Time to value (TTV)
2. Map critical path
Setup -> First Use -> First Value -> Habit
3. Remove friction
- Reduce steps to Aha moment
- Defer non-essential setup
- Progressive disclosure
4. Measure activation rate
- % reaching Aha moment in Day 1
- % reaching in Week 1
- Drop-off pointsOnboarding by User Type
| User Type | Goal | Approach |
|---|---|---|
| Self-serve | Quick win | Minimal guidance, clear CTAs |
| Assisted | Full setup | Guided tour + checklist |
| Enterprise | Team rollout | Admin setup + training |
| Technical | Deep understanding | Docs + sandbox |
Onboarding Sequences
Checklist Pattern
ONBOARDING CHECKLIST DESIGN
Structure:
- Account setup (required)
-> Profile basics
-> Connect integrations
- First [core action] (required)
-> Guided walkthrough
-> Celebrate completion
- Invite team (recommended)
-> Team benefits explained
-> Easy invite flow
- Advanced setup (optional)
-> Power features
-> When ready prompt
UI Best Practices:
- Progress indicator (3/5 complete)
- Estimated time per step
- Skip option (but track)
- Persistent but dismissible
- Re-accessible from menuEmail Sequence
ONBOARDING EMAIL FLOW
Day 0 (Immediate):
Subject: Welcome to [Product] - Start here
Content: Quick start link, support contact
Day 1:
Subject: Complete your setup in 5 minutes
Content: Checklist progress, unfinished steps
Day 3:
Subject: [Feature] tip: [specific value]
Content: One feature highlight, use case
Day 7:
Subject: You're doing great - here's what's next
Content: Progress summary, advanced features
Day 14:
Subject: [Segment-specific content]
Content: Based on usage patterns
TRIGGERS (alternative to time-based):
- After first action -> Next step email
- After inactivity (3d) -> Re-engagement
- After milestone -> Celebration + next levelIn-App Onboarding Flow
IN-APP SEQUENCE
1. Welcome modal
- Personalization question
- "What's your goal?"
- Route to appropriate path
2. Guided setup (critical path only)
- Tooltip chain for setup
- Celebrate completions
- Max 5 steps to first value
3. Contextual prompts
- Feature discovery on hover
- Empty state education
- "Did you know?" nudges
4. Progress tracking
- Onboarding checklist widget
- Achievement unlocks
- Setup score/percentageTutorial Design
Video Tutorial Best Practices (2025)
VIDEO SPECIFICATIONS
Length:
- Quick tip: 30-60 seconds
- How-to: 2-4 minutes (optimal)
- Deep dive: 5-10 minutes max
Format:
- Screen recording + voiceover
- Face optional (improves trust)
- Captions always (accessibility + silent viewing)
Structure:
0:00 - Hook (problem/outcome)
0:15 - Prerequisites (if any)
0:30 - Step-by-step walkthrough
X:XX - Result demonstration
X:XX - Next steps / CTA
PRODUCTION TIPS
- Consistent intro/outro (3-5 sec)
- Zoom on important UI elements
- Highlight clicks/actions
- Pause on complex steps
- Clean desktop/browser
- HD quality (1080p minimum)Interactive Guide Patterns
GUIDE TYPES
1. Product Tour
- Full feature walkthrough
- Use for: New users, new features
- Length: 5-10 steps
- Trigger: First login, feature release
2. Spotlight
- Single element highlight
- Use for: New feature, hidden feature
- Length: 1-3 steps
- Trigger: First visit to area
3. Tooltip Chain
- Sequential tooltips
- Use for: Complex workflows
- Length: 3-7 steps
- Trigger: User starts action
4. Hotspot
- Persistent help indicator
- Use for: Complex forms
- Length: On-demand
- Trigger: Always visible
5. Checklist
- Progress tracker
- Use for: Onboarding, setup
- Length: 5-10 items
- Trigger: Account creationMicro-Learning Format
MICRO-LEARNING DESIGN
Principle: "Moment of need" support
Format:
- 1-3 minute content chunks
- Single concept per unit
- Immediately applicable
- Available in-context
Types:
- GIF demos (5-15 sec)
- Step cards (3-5 steps)
- Quick videos (60-90 sec)
- Interactive clickthroughs
Delivery:
- Contextual help panel
- Search results
- AI assistant suggestions
- Email tipsIn-App Help Patterns
Tooltip Best Practices
TOOLTIP DESIGN
Content:
- Max 2 short sentences
- Action-oriented language
- Link to "Learn more" if needed
Positioning:
- Adjacent to element
- Never cover important UI
- Consistent placement (top/right preferred)
Behavior:
- Hover-triggered (desktop)
- Click-triggered (mobile)
- Dismissible with X
- Don't re-show if dismissed
EXAMPLE
"Import your contacts from CSV, Excel, or
directly from Google Contacts. [Learn more]"Empty State Education
EMPTY STATE PATTERN
Components:
1. Illustration (friendly, relevant)
2. Headline (benefit-focused)
3. Description (what to do)
4. Primary CTA (start action)
5. Secondary link (learn more)
EXAMPLE
[Illustration: Person organizing tasks]
"Get organized with your first project"
Projects help you group related tasks,
track progress, and collaborate with your team.
[+ Create Project] (primary)
"Watch a quick tour" (secondary)Contextual Help Panel
HELP PANEL DESIGN
Trigger:
- ? icon in UI
- Keyboard shortcut (?)
- Menu item (Help)
Content:
- Relevant to current page
- Search box
- Quick links (top 3-5)
- AI assistant option
- Contact support fallback
Behavior:
- Slide-in from right
- Doesn't navigate away
- Persists across pages
- Easy dismiss (X or outside click)Error State Education
ERROR MESSAGE PATTERN
Structure:
1. What happened (clear, non-technical)
2. Why it happened (if known)
3. How to fix it (actionable steps)
4. Help link (if complex)
EXAMPLES
Bad: "Error 403: Forbidden"
Good:
"You don't have access to this page
This page is only available to Admin users.
If you need access, contact your team admin.
[Request Access] [Go to Dashboard]"
---
Bad: "Validation failed"
Good:
"Please fix these issues to continue:
- Email: Enter a valid email address
- Password: Must be at least 8 characters
- Company: This field is required"Course Structure
Learning Path Design
LEARNING PATH FRAMEWORK
Structure:
Path -> Modules -> Lessons -> Topics
Path: "Become a Power User"
|-- Module 1: Getting Started (Beginner)
| |-- Lesson 1.1: Account Setup
| |-- Lesson 1.2: Dashboard Overview
| \\-- Lesson 1.3: First [Action]
|-- Module 2: Core Features (Intermediate)
| |-- Lesson 2.1: [Feature A]
| |-- Lesson 2.2: [Feature B]
| \\-- Lesson 2.3: [Feature C]
\\-- Module 3: Advanced (Expert)
|-- Lesson 3.1: Automation
|-- Lesson 3.2: Integrations
\\-- Lesson 3.3: Best Practices
EACH LESSON INCLUDES:
- Video (2-4 min)
- Written guide
- Practice exercise
- Quiz (optional)
- Completion badgeCourse Content Templates
# Lesson: [Lesson Title]
**Duration**: [X minutes]
**Level**: [Beginner/Intermediate/Advanced]
**Prerequisites**: [List or "None"]
## Learning Objectives
By the end of this lesson, you will:
- [ ] [Objective 1]
- [ ] [Objective 2]
- [ ] [Objective 3]
## Video Tutorial
[Embedded video]
## Step-by-Step Guide
### Step 1: [Action]
[Instructions]

### Step 2: [Action]
[Instructions]
> **Tip**: [Helpful hint]
## Practice Exercise
Try this on your own:
1. [Task 1]
2. [Task 2]
3. [Task 3]
**Expected result**: [What they should see]
## Quiz (Optional)
1. [Question]
- [ ] Option A
- [ ] Option B
- [x] Option C (correct)
## Summary
Key takeaways:
- [Point 1]
- [Point 2]
- [Point 3]
## Next Steps
- [Next lesson link]
- [Related resource]
- [Practice project]Certification Programs
CERTIFICATION STRUCTURE
Levels:
1. Foundation (Basics)
2. Professional (Core competency)
3. Expert (Advanced + real-world)
Requirements per level:
- Complete all modules
- Pass assessment (70%+ score)
- Practical project (optional)
Assessment types:
- Multiple choice quiz
- Hands-on tasks
- Scenario-based questions
- Peer review (expert level)
Benefits:
- Badge/certificate
- LinkedIn credential
- Community recognition
- Partner/agency requirementTools & Platforms
Onboarding Tools Comparison
| Tool | Best For | Pricing | Key Feature |
|---|---|---|---|
| Appcues | No-code flows | $$$ | Visual builder |
| UserPilot | PLG companies | $$ | Segment targeting |
| Pendo | Enterprise | $$$$ | Analytics depth |
| Whatfix | Complex enterprise | $$$$ | DAP features |
| Chameleon | Startups | $ | Simple setup |
| Intercom Tours | Intercom users | Included | Messenger integration |
Video Hosting
| Platform | Best For | Features |
|---|---|---|
| Loom | Quick captures | Easy recording, sharing |
| Wistia | Marketing | CTAs, heatmaps, SEO |
| Vidyard | Sales/support | Personalization |
| YouTube | Public content | Free, SEO |
| Vimeo | Professional | Quality, privacy |
Course Platforms
| Platform | Best For | Type |
|---|---|---|
| Thinkific | Course business | Hosted |
| Teachable | Creators | Hosted |
| LearnDash | WordPress | Plugin |
| Skilljar | Customer education | Enterprise |
| WorkRamp | Employee training | Enterprise |
Metrics & Optimization
Onboarding Metrics
| Metric | Definition | Benchmark |
|---|---|---|
| Activation rate | % reaching Aha moment | 30-50% |
| Onboarding completion | % finishing checklist | 60-80% |
| Time to value | Time to first value | <1 day ideal |
| Tour completion | % finishing tours | 40-60% |
| Drop-off point | Where users abandon | Identify & fix |
| Feature adoption | % using key features | Track per feature |
Tutorial Metrics
| Metric | Definition | Target |
|---|---|---|
| Video completion | % watching to end | >60% |
| Avg. watch time | Seconds viewed | >70% of length |
| Rewatch rate | % rewatching | <20% (too complex?) |
| Help -> action | Tutorial -> feature use | Track correlation |
| Support ticket reduction | Tickets pre/post | 20-40% reduction |
Optimization Strategies
CONTINUOUS IMPROVEMENT
Weekly:
- Review drop-off points
- Check completion rates
- Identify stuck users
Monthly:
- Update outdated content
- A/B test tour variants
- Analyze feature adoption
Quarterly:
- Full onboarding audit
- User interviews
- Benchmark against peers
- Rebuild underperforming flowsAccessibility
Accessible Onboarding
ACCESSIBILITY REQUIREMENTS
Visual:
- Sufficient color contrast (4.5:1)
- Don't rely on color alone
- Alt text for images/GIFs
- Captions for all videos
Interaction:
- Keyboard navigable tours
- Focus management
- Skip options
- Respect reduced motion
Content:
- Clear, simple language
- Reading level: Grade 8
- Avoid jargon
- Multiple formats (video + text)
TESTING
- Screen reader testing (NVDA, VoiceOver)
- Keyboard-only navigation
- Color blindness simulation
- Automated a11y tools (axe, Lighthouse)Metrics & Optimization
KPI tracking, analytics setup, and optimization strategies for help centers.
Contents
- Core Metrics Framework
- ROI Calculation
- Analytics Setup
- Search Analytics
- Content Performance
- A/B Testing
- Feedback Analysis
- Optimization Playbook
- Benchmarking
- Alerting & Monitoring
Core Metrics Framework
Primary KPIs
| Metric | Definition | Target | Formula |
|---|---|---|---|
| Self-Service Rate | % issues resolved without agent | 60-80% | (KB Resolutions / Total Issues) x 100 |
| Ticket Deflection | Tickets avoided via KB | 30-50% | (Article Views x Deflection Rate) |
| Search Success Rate | % searches -> helpful result | >70% | (Successful Searches / Total Searches) x 100 |
| CSAT (KB) | Article helpfulness rating | >80% positive | (Positive Votes / Total Votes) x 100 |
| Zero-Result Rate | Searches with no results | <5% | (Zero-Result Searches / Total Searches) x 100 |
Secondary KPIs
| Metric | Definition | Target |
|---|---|---|
| Avg. Time on Page | Reading engagement | 2-5 min |
| Bounce Rate | Single-page exits | <40% |
| Article Views | Total/unique views | Trending up |
| Search-to-Ticket | Searches before ticket | 1-3 searches |
| Contact Rate | % who contact support | <20% |
ROI Calculation
Cost-Benefit Analysis
SELF-SERVICE ROI MODEL
Costs:
- Platform subscription: $XXX/month
- Content creation: $XXX/month
- Maintenance: $XXX/month
Total monthly cost: $XXXX
Savings:
- Average cost per ticket: $13
- Tickets deflected: X,XXX/month
- Deflection savings: $XX,XXX/month
Net ROI:
Monthly savings - Monthly cost = Net benefit
(Net benefit / Cost) x 100 = ROI %
EXAMPLE
Platform: $500/month
Content: $1,000/month
Maintenance: $500/month
Total cost: $2,000/month
Deflected tickets: 2,000/month
Cost per ticket: $13
Deflection savings: $26,000/month
Net benefit: $24,000/month
ROI: 1,100%Cost Per Resolution
CHANNEL COST COMPARISON
| Channel | Avg. Cost | Resolution Time |
|---------|-----------|-----------------|
| Phone | $15-25 | 8-12 min |
| Email | $10-15 | 24-48 hours |
| Live Chat | $8-12 | 5-10 min |
| AI Chatbot | $0.50-2 | 1-3 min |
| Self-Service | $0.10-0.50 | User-controlled |
TARGET: Maximize self-service, minimize phoneAnalytics Setup
Google Analytics 4 Configuration
// GA4 Event Tracking for Help Center
// Article view
gtag('event', 'article_view', {
article_id: '12345',
article_title: 'How to Reset Password',
category: 'Account',
content_type: 'how-to'
});
// Search performed
gtag('event', 'search', {
search_term: 'password reset',
results_count: 5
});
// Article feedback
gtag('event', 'article_feedback', {
article_id: '12345',
feedback_type: 'helpful', // or 'not_helpful'
feedback_text: 'Optional comment'
});
// Contact support clicked
gtag('event', 'contact_support', {
source_article: '12345',
contact_method: 'chat'
});Key Events to Track
ESSENTIAL EVENTS
Page/Article level:
- article_view (with metadata)
- scroll_depth (25%, 50%, 75%, 100%)
- time_on_page
- related_article_click
- external_link_click
Search:
- search_performed
- search_result_click
- zero_results
- search_refinement
Feedback:
- helpful_yes
- helpful_no
- feedback_submitted
- escalation_to_support
AI/Chatbot:
- chatbot_opened
- chatbot_message_sent
- chatbot_resolved
- chatbot_escalatedDashboard Template
HELP CENTER DASHBOARD
Overview Section:
Self-Service Rate: 72%
Deflection: 65%
Search Performance:
Searches today: 1,234
Success rate: 78%
Zero results: 4.2%
Top searches: password, pricing, api
Content Health:
Total articles: 156
Updated <30 days: 45 (29%)
Low-rated (<3/5): 12
High-traffic, low-rated: 5 (priority)
Trend Chart:
[Line chart: tickets, KB views, search success rate]Search Analytics
Search Performance Metrics
SEARCH METRICS
Volume:
- Total searches/day
- Unique searchers
- Searches per session
Quality:
- Click-through rate (CTR)
- Position of clicked result
- Refinement rate (search again)
Gaps:
- Zero-result queries
- Low-CTR queries
- High-exit searches
ZERO-RESULT ANALYSIS
Weekly review process:
1. Export zero-result queries
2. Group by topic/intent
3. Prioritize by volume
4. Actions:
- Create new article
- Add synonyms
- Update titles
- Add redirectsSearch Optimization Actions
| Signal | Diagnosis | Action |
|---|---|---|
| High volume, zero results | Missing content | Create article |
| High volume, low CTR | Poor title/description | Rewrite metadata |
| Click -> immediate exit | Content mismatch | Update content |
| Multiple searches same topic | Hard to find | Add synonyms |
| Search -> ticket | Content insufficient | Expand article |
Content Performance
Article Scoring Model
ARTICLE HEALTH SCORE (0-100)
Components:
- Helpfulness rating: 30 points
- Traffic volume: 20 points
- Engagement (time on page): 15 points
- Freshness: 15 points
- Search performance: 10 points
- Link health: 10 points
SCORING EXAMPLE
Article: "How to Reset Password"
Helpfulness: 85% positive -> 25/30 points
Traffic: Top 10% -> 20/20 points
Engagement: 3.5 min avg -> 12/15 points
Freshness: Updated 2 months ago -> 12/15 points
Search: #2 result for "password" -> 8/10 points
Links: All working -> 10/10 points
Total Score: 87/100 (Healthy)Content Audit Framework
QUARTERLY AUDIT PROCESS
1. Export all articles with metrics
- Views (30/90/365 days)
- Helpfulness rating
- Last updated date
- Ticket escalations
2. Categorize by action needed
OK Healthy (score >70):
- No action needed
- Review in 6 months
Medium Needs attention (50-70):
- Update content
- Improve visuals
- Check accuracy
Critical Critical (<50):
- Major rewrite
- Consider archive
- Urgent if high-traffic
3. Prioritize by impact
High traffic + low score = Priority 1
Low traffic + low score = Consider archive
4. Track improvements
Before/after metrics per articleContent Gap Analysis
IDENTIFYING GAPS
Data sources:
- Zero-result searches
- High-volume support tickets
- User feedback comments
- Sales/success team input
- Product release notes
PROCESS
1. Collect gap signals (weekly)
2. Categorize by topic
3. Score by impact:
- Ticket volume reduction potential
- User demand (search volume)
- Strategic importance
4. Create backlog
5. Prioritize creation
GAP TEMPLATE
Topic: [Gap topic]
Evidence: [Data showing need]
Impact: [High/Medium/Low]
Effort: [Hours to create]
Priority: [P1/P2/P3]
Assigned: [Author]
Due: [Date]A/B Testing
What to Test
TESTABLE ELEMENTS
Titles:
- Question vs. statement
- Verb-first vs. noun-first
- Short vs. descriptive
Content:
- Steps count (5 vs. 10)
- Video vs. text
- Screenshots vs. GIFs
Layout:
- TOC position
- Related articles placement
- CTA button position
Search:
- Result ordering
- Snippet length
- Filter optionsA/B Test Framework
TEST STRUCTURE
1. Hypothesis
"Changing [element] from [A] to [B]
will improve [metric] by [X]%"
2. Success metric
Primary: [e.g., CTR, helpfulness]
Secondary: [e.g., time on page]
3. Sample size
Use calculator for statistical significance
Minimum: 1,000 views per variant
4. Duration
Minimum: 2 weeks
Account for weekly patterns
5. Analysis
- Statistical significance (p < 0.05)
- Practical significance (>5% lift)
- Segment analysis
EXAMPLE TEST
Hypothesis: "How to" prefix increases CTR
Control: "Reset Your Password"
Variant: "How to Reset Your Password"
Metric: Click-through from search
Duration: 2 weeks
Result: +12% CTR (p=0.02) -> ImplementFeedback Analysis
Feedback Collection Methods
FEEDBACK TYPES
Binary:
"Was this helpful?" [Yes] [No]
- Simple, high response rate
- Limited insight
Rating scale:
"Rate this article" 4/5
- More nuanced
- Moderate response rate
Open text:
"How can we improve this?"
- Rich insight
- Low response rate
Inline feedback:
Highlight -> "Is this unclear?"
- Contextual
- High-quality signal
BEST PRACTICE
Combine:
1. Binary (always show)
2. Follow-up question (on "No")
3. Optional text (for details)Feedback Processing
FEEDBACK WORKFLOW
Daily:
- Review new feedback
- Flag urgent issues
- Categorize comments
Weekly:
- Analyze patterns
- Update priority articles
- Report to team
Monthly:
- Trend analysis
- Process improvements
- Content planning input
CATEGORIZATION
- Accuracy issue (content wrong)
- Completeness (missing info)
- Clarity (confusing)
- Outdated (needs update)
- Praise (positive)
- Off-topic (ignore)Optimization Playbook
Quick Wins (<1 hour each)
IMMEDIATE IMPACT ACTIONS
1. Fix broken links
- Run link checker
- Update or remove
2. Add missing screenshots
- High-traffic how-to articles
- Error message articles
3. Update dates
- "Last updated" timestamps
- Version numbers
4. Add search synonyms
- Top zero-result queries
- Common misspellings
5. Improve titles
- Add action verbs
- Match search queriesMedium Effort (1 day each)
SIGNIFICANT IMPROVEMENTS
1. Rewrite low-rated articles
- Address feedback themes
- Add visual aids
- Simplify language
2. Create missing content
- Top 5 zero-result queries
- Frequent ticket topics
3. Consolidate duplicates
- Merge similar articles
- Set up redirects
4. Improve navigation
- Update category structure
- Add cross-links
- Improve breadcrumbsStrategic Projects (1 week+)
TRANSFORMATIONAL CHANGES
1. AI integration
- Implement chatbot
- Set up RAG pipeline
- Configure escalation
2. Content redesign
- New templates
- Consistent formatting
- Visual refresh
3. Search overhaul
- Semantic search
- Personalization
- Federated search
4. Analytics upgrade
- Custom dashboards
- Automated alerts
- Predictive analyticsBenchmarking
Industry Benchmarks
BENCHMARK RANGES
Self-Service Rate:
- Low: <40%
- Average: 50-65%
- Best-in-class: >75%
Ticket Deflection:
- Low: <20%
- Average: 30-45%
- Best-in-class: >55%
Search Success:
- Low: <60%
- Average: 70-80%
- Best-in-class: >85%
CSAT (KB):
- Low: <70%
- Average: 75-82%
- Best-in-class: >88%
NOTE: Benchmarks vary by industry
- B2B SaaS: Higher self-service expected
- E-commerce: Lower (simpler queries)
- Enterprise: Variable by product complexityCompetitive Analysis
COMPETITIVE INTEL CHECKLIST
Analyze competitor help centers:
Structure:
- Category organization
- Article types
- Navigation patterns
- Search prominence
Content:
- Writing style
- Visual approach
- Depth of content
- Update frequency
Features:
- AI chatbot presence
- Community forums
- Video content
- Interactive guides
UX:
- Mobile experience
- Load time
- Accessibility
- Personalization
Document findings:
- What they do better
- What we do better
- Opportunities to differentiateAlerting & Monitoring
Alert Configuration
AUTOMATED ALERTS
Critical (immediate):
- Zero-result rate >10%
- Helpfulness <60%
- Site down/errors
Warning (daily digest):
- Traffic drop >20% WoW
- New low-rated articles
- Stale content (>6 months)
Info (weekly summary):
- Top performing content
- Trending searches
- Feedback themes
ALERT TEMPLATE
Subject: [Severity] Help Center Alert: [Issue]
What: [Description of issue]
Impact: [Metric change]
Affected: [Articles/pages]
Action: [Recommended fix]
Link: [Dashboard/article link]Health Check Automation
WEEKLY AUTOMATED CHECKS
- Broken link scan
- Image loading verification
- Search functionality test
- Chatbot response test
- Mobile rendering check
- Load time measurement
- SSL certificate validity
- Analytics tracking verification
MONTHLY AUTOMATED REPORTS
- Content freshness report
- Search performance summary
- Feedback trend analysis
- Traffic comparison (MoM, YoY)
- Top/bottom performers
- Gap analysis updateMultilingual Support
Operational patterns for running a multilingual help center at scale.
Contents
- Translation workflow
- Platform capabilities
- Translation management tools
- Machine translation + human review
- Glossary management
- Content prioritization
- URL structure for multilingual content
- RTL language support
- Measuring coverage and quality
- Checklist: multilingual launch readiness
- Do/Avoid
Translation Workflow
Standard four-stage pipeline from source to published translation.
TRANSLATION PIPELINE
1. Source authoring
- Write and publish article in source language (usually English)
- Mark article as "ready for translation"
- Freeze source content during translation cycle
2. Translation
- Send to translation vendor, internal team, or MT engine
- Provide glossary and style guide with every batch
- Include screenshots with callout text for context
3. Review
- Native speaker reviews for accuracy and tone
- Product SME validates technical correctness
- QA checks formatting, links, and placeholder variables
4. Publish
- Publish translated article linked to source
- Verify URL structure and hreflang tags
- Update sitemap with new language URLsBatch cadence: weekly for high-volume, biweekly for steady-state, per-release for product-driven content.
Platform Capabilities
| Platform | Multilingual Support | How It Works |
|---|---|---|
| Zendesk Guide | Native | Built-in localization per article. Toggle languages in Guide settings. Auto-detects user locale. |
| Intercom | Native | Content localization per article. Language targeting in Messenger. Fin supports multiple languages. |
| Freshdesk | Native | Multi-language knowledge base. Separate folders per language. Auto-detect or manual toggle. |
| GitBook | Manual/Plugin | No native multilingual. Use separate spaces per language or variant groups. |
| Notion | Manual | Duplicate pages per language. No locale detection. Not recommended for multilingual. |
| Confluence | Plugin | Scroll Translations or manual page copies. Enterprise-oriented. |
For platforms without native multilingual support, use a TMS (translation management system) with API integration.
Translation Management Tools
| Tool | Strength | Pricing Model | Best For |
|---|---|---|---|
| Crowdin | Developer-friendly, Git integration | Free for open source; from $40/mo | Technical docs, developer products |
| Phrase (Memsource) | Enterprise TMS, CAT tools, TM/glossary | From $25/user/mo | Large-scale, agency workflows |
| Transifex | Continuous localization, API-first | From $120/mo | SaaS products, frequent updates |
| Lokalise | Clean UI, screenshot context, branching | From $120/mo | Product teams, mobile + web |
| Smartling | Enterprise, neural MT, connector library | Custom pricing | Enterprise, regulated industries |
Selection criteria: integration with your help center platform, support for translation memory, glossary management, and reviewer workflows.
Machine Translation + Human Review
Pure machine translation is not ready for customer-facing help content. Use MT as a first draft, then human-review.
MT + HUMAN REVIEW WORKFLOW
1. Source article finalized in English
2. Run through MT engine (DeepL, Google Cloud Translation, or TMS built-in)
3. Human reviewer edits for:
- Product terminology (MT often mistranslates feature names)
- Tone and formality (varies by locale)
- UI label accuracy (must match localized product UI)
- Cultural references and idioms
4. QA pass: check formatting, variables, links
5. Publish
QUALITY TIERS
Tier 1 (full human translation): legal, billing, security content
Tier 2 (MT + human review): how-to guides, feature docs
Tier 3 (MT + light review): release notes, changelog, low-traffic articlesExpected effort reduction with MT + review vs. full translation: 40-60% cost savings, 50-70% faster turnaround.
Glossary Management
Glossary prevents inconsistent translations of product-specific terms.
GLOSSARY STRUCTURE
| Source Term | Target (es) | Target (de) | Target (ja) | Notes |
|-------------|-------------|-------------|-------------|-------|
| Dashboard | Dashboard | Dashboard | ダッシュボード | Do not translate |
| Workspace | Espacio de trabajo | Arbeitsbereich | ワークスペース | Translate |
| SSO | SSO | SSO | SSO | Acronym — keep as-is |
| Admin | Administrador | Administrator | 管理者 | Translate |
GLOSSARY RULES
- Brand name: never translate
- Product feature names: follow localized UI (check with product team)
- Technical acronyms (API, SSO, URL): keep in English unless locale convention differs
- UI labels: must match exactly what the user sees in the localized product
- Legal terms: use jurisdiction-appropriate equivalents, reviewed by legal
MAINTENANCE
- Update glossary with every product release that adds or renames features
- Share glossary with all translators and reviewers
- Store in TMS (single source of truth) or versioned spreadsheetContent Prioritization
Translate the highest-impact content first, not everything at once.
PRIORITIZATION FRAMEWORK
Phase 1 — Core (launch requirement):
- Top 20 articles by traffic
- Getting started / onboarding flow
- Billing and account management
- Contact support page
Phase 2 — Expand (first 30 days post-launch):
- Next 30 articles by traffic
- Troubleshooting for top error messages
- FAQ pages
Phase 3 — Long tail (ongoing):
- Remaining articles by descending traffic
- Release notes (translate per release)
- Community guidelines
DECISION GUIDE
Translate a new language when:
- 10%+ of traffic comes from that locale
- Sales is actively selling in that market
- Legal/regulatory requirements mandate it (e.g., EU, Quebec)
- Support ticket volume in that language exceeds 5% of totalURL Structure for Multilingual Content
| Pattern | Example | Pros | Cons |
|---|---|---|---|
| Subdirectory | example.com/es/help/article | Simple, single domain, good for SEO | Slightly longer URLs |
| Subdomain | es.help.example.com | Clear separation, independent hosting | More DNS/SSL management |
| Parameter | example.com/help/article?lang=es | Easiest to implement | Poor for SEO, not recommended |
| Separate domain | ayuda.example.es | Strong local signal | Expensive, hard to maintain |
Recommended: subdirectory (/en/, /es/, /de/). Best balance of SEO, simplicity, and maintenance.
HREFLANG IMPLEMENTATION
Add to every page <head>:
<link rel="alternate" hreflang="en" href="https://help.example.com/en/article" />
<link rel="alternate" hreflang="es" href="https://help.example.com/es/article" />
<link rel="alternate" hreflang="de" href="https://help.example.com/de/article" />
<link rel="alternate" hreflang="x-default" href="https://help.example.com/en/article" />
RULES
- Every translated page must reference all its language variants
- x-default points to the fallback (usually English)
- Submit all language variants in sitemapRTL Language Support
Languages requiring right-to-left layout: Arabic, Hebrew, Farsi, Urdu.
RTL REQUIREMENTS
Layout:
- Mirror the entire page layout (navigation, sidebars, content flow)
- Use CSS logical properties (margin-inline-start instead of margin-left)
- Set dir="rtl" and lang attribute on <html> or content container
Typography:
- Use fonts that support Arabic/Hebrew glyphs (Noto Sans Arabic, IBM Plex Arabic)
- Increase line height by 10-20% for Arabic script readability
- Do not justify Arabic text — use right-aligned
Content:
- Numbers remain left-to-right within RTL text (bidirectional)
- UI screenshots must show RTL version of the product (if available)
- Code blocks remain LTR even in RTL articles
Testing:
- Test with native RTL speakers, not just visual inspection
- Verify breadcrumbs, tables, and navigation reverse correctly
- Check that mixed LTR/RTL content (English terms in Arabic text) renders properlyMeasuring Coverage and Quality
COVERAGE METRICS
| Metric | Formula | Target |
|--------|---------|--------|
| Translation coverage | Translated articles / Total articles x 100 | >80% for Tier 1 languages |
| Top-article coverage | Translated top-50 / 50 x 100 | 100% |
| Freshness | Translations updated within 7 days of source change | >90% |
| Missing translations | Articles with no translation in active languages | 0 for Phase 1 content |
QUALITY METRICS
| Metric | How to Measure | Target |
|--------|----------------|--------|
| Helpfulness per locale | Article feedback ratings by language | Within 10% of source language |
| Escalation rate per locale | Tickets after article view, by language | Within 15% of source language |
| Glossary compliance | Spot-check sample of translated articles | >95% correct term usage |
| Linguistic quality | Monthly review by native speaker (sample 10 articles) | Score 4+/5 |Checklist: Multilingual Launch Readiness
PRE-LAUNCH
- [ ] Target languages selected based on traffic/market data
- [ ] Glossary created and shared with translators
- [ ] TMS configured and integrated with help center platform
- [ ] URL structure defined (subdirectory recommended)
- [ ] Hreflang tags implemented
- [ ] Phase 1 content translated and reviewed
- [ ] RTL support tested (if applicable)
- [ ] Language switcher visible and functional
- [ ] Locale auto-detection configured (with manual override)
- [ ] Analytics configured to segment by language
POST-LAUNCH
- [ ] Sitemap updated with all language URLs
- [ ] Google Search Console shows indexed translations
- [ ] Helpfulness ratings tracked per language
- [ ] Translation freshness monitoring active
- [ ] Feedback loop established: support team flags translation issuesDo/Avoid
DO
- Start with top 20 articles, not full coverage
- Use a TMS with translation memory to reduce cost over time
- Match translated UI labels exactly to the localized product
- Freeze source content during active translation cycles
- Track helpfulness per language separately
- Budget for ongoing translation with every release
AVOID
- Publishing raw machine translation without human review
- Translating screenshots by overlaying text (re-capture in localized UI instead)
- Assuming one Spanish variant works for all Spanish-speaking markets
- Ignoring RTL requirements until after launch
- Treating translation as a one-time project (it is ongoing ops)
- Letting glossary drift out of sync with the productPlatform Guides
Setup and configuration guides for help center platforms.
Contents
- Platform Selection Matrix
- Zendesk Guide Setup
- Intercom Setup
- Freshdesk Setup
- GitBook Setup
- Notion as Help Center
- Enterprise AI Platforms (2026)
- Migration Guide
Platform Selection Matrix
By Company Stage
| Stage | Revenue | Team Size | Recommended | Why |
|---|---|---|---|---|
| Pre-seed/Seed | <$1M ARR | 1-10 | Notion + Intercom | Low cost, fast setup |
| Series A | $1-5M ARR | 10-50 | Intercom or Freshdesk | Balance features/cost |
| Series B+ | $5-20M ARR | 50-200 | Zendesk or Intercom | Scalability, integrations |
| Enterprise | >$20M ARR | 200+ | Zendesk | Compliance, customization |
By Use Case
| Use Case | Best Platform | Alternatives |
|---|---|---|
| Developer docs | GitBook, ReadMe | Docusaurus, Mintlify |
| SaaS help center | Intercom, Zendesk | Freshdesk, HelpScout |
| E-commerce support | Zendesk, Gorgias | Freshdesk, Gladly |
| Internal knowledge | Notion, Guru | Confluence, Slite |
| API documentation | ReadMe, Stoplight | Swagger, Redocly |
Feature Comparison
| Feature | Zendesk | Intercom | Freshdesk | GitBook |
|---|---|---|---|---|
| Help Center | Yes | Yes | Yes | Yes |
| Ticketing | Yes | Yes | Yes | No |
| Live Chat | Yes | Yes | Yes | No |
| AI Chatbot | Add-on | Fin ($0.99/res) | Freddy (built-in) | No |
| Email Support | Yes | Yes | Yes | No |
| Docs-as-Code | No | No | No | Yes |
| API | Full | Full | Full | Full |
| SSO | Enterprise | Yes | Pro+ | Business |
| HIPAA | Enterprise | Enterprise | Enterprise | No |
| Starting Price | $55/agent | $29/seat | $15/agent | Free |
Zendesk Guide Setup
Initial Configuration
SETUP CHECKLIST
1. Create Help Center
Admin > Guide > Activate Guide
2. Configure settings
- Default language
- Search settings
- SEO settings (sitemap, robots.txt)
- Google Analytics
3. Brand customization
- Logo, colors, favicon
- Header/footer
- Custom CSS
- Theme selection
4. Structure
- Create categories
- Create sections
- Set permissions (public/internal)
5. Content migration
- Import from CSV
- API migration
- Manual creationTheme Customization
/* Zendesk Copenhagen Theme Customization */
/* Brand colors */
:root {
--primary-color: #1a73e8;
--secondary-color: #5f6368;
--background-color: #ffffff;
--text-color: #202124;
}
/* Search bar prominence */
.search-container {
background: var(--primary-color);
padding: 60px 20px;
}
/* Article styling */
.article-body {
max-width: 800px;
line-height: 1.6;
font-size: 16px;
}
/* Category cards */
.category-card {
border-radius: 8px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
transition: transform 0.2s;
}Zendesk AI Configuration
ANSWER BOT SETUP
1. Enable Answer Bot
Admin > Channels > Bots > Answer Bot
2. Training sources
- Help Center articles (primary)
- Canned responses
- Previous tickets
3. Trigger configuration
- Web Widget
- Email auto-reply
- Ticket creation flow
4. Confidence thresholds
- High (show answer): >0.8
- Medium (show with disclaimer): 0.6-0.8
- Low (don't show): <0.6
5. Escalation rules
- No match -> Create ticket
- Low confidence -> Offer human
- Negative feedback -> EscalateZendesk Best Practices
CONTENT ORGANIZATION
- Use labels for cross-cutting topics
- Enable article voting
- Set up content cues (auto-suggestions)
- Use internal articles for sensitive docs
- Archive outdated content (don't delete)
SEARCH OPTIMIZATION
- Add search synonyms
- Configure promoted results
- Review zero-result searches weekly
- Use article labels for filtering
PERFORMANCE
- Enable CDN for images
- Compress images before upload
- Use lazy loading
- Monitor page load timesIntercom Setup
Initial Configuration
SETUP CHECKLIST
1. Create Help Center
Settings > Help Center > Enable
2. Configure collection structure
- Create collections (categories)
- Set collection icons
- Configure order
3. Customize appearance
- Brand colors
- Custom header
- Search bar styling
- Article formatting
4. Content settings
- Default language
- Multi-language setup
- Public vs. private articles
5. Integration
- Embed in Messenger
- Enable article suggestions
- Connect to Fin AIFin AI Configuration
FIN SETUP
1. Enable Fin
Settings > Fin > Enable
2. Content sources
- Help Center articles (automatic)
- Public website URLs
- Custom snippets
3. Configure behavior
- Persona/tone
- Business hours
- Languages
- Handoff triggers
4. Test in sandbox
- Test common queries
- Review answer quality
- Adjust prompts
5. Gradual rollout
- Start with 10% traffic
- Monitor metrics
- Increase to 100%
PRICING
$0.99 per Fin resolution
Resolution = User marks as helpful OR doesn't escalate
COST OPTIMIZATION
- Improve content quality -> Higher resolution rate
- Clear escalation paths -> Fewer false resolutions
- Target: 60-70% Fin resolution rateIntercom Messenger Configuration
MESSENGER SETTINGS
Home screen:
- Recent articles
- Quick links
- Start conversation
Conversation settings:
- Auto-assign rules
- Business hours
- Away message
Article suggestions:
- Enable in Messenger
- Show during typing
- Smart suggestions
Proactive messages:
- Trigger on page view
- Time-based targeting
- User segment targetingIntercom Best Practices
CONTENT STRATEGY
- Keep articles concise (<500 words)
- Use rich media (images, GIFs, video)
- Cross-link related articles
- Regular freshness reviews
MESSENGER OPTIMIZATION
- Pin important articles
- Use article cards in conversations
- Enable suggested replies
- Configure macros for agents
FIN OPTIMIZATION
- Clear, keyword-rich titles
- FAQ structure (question as heading)
- Avoid duplicate content
- Update based on Fin feedbackFreshdesk Setup
Initial Configuration
SETUP CHECKLIST
1. Create Knowledge Base
Admin > Support Channels > Knowledge Base
2. Structure setup
- Create categories
- Create folders
- Set visibility (all/customers/agents)
3. Customize portal
- Brand colors
- Logo and favicon
- Custom domain
- Header/footer
4. SEO settings
- Meta descriptions
- Sitemap generation
- Social sharing
5. Freddy AI
- Enable Answer Bot
- Train on KB content
- Configure triggersFreddy AI Configuration
FREDDY SETUP
1. Enable Freddy
Admin > Freddy > Answer Bot
2. Training
- Solution articles (primary)
- Canned responses
- Historical tickets
3. Channels
- Chat widget
- Email auto-reply
- Ticket creation
4. Behavior
- Confidence threshold
- Fallback message
- Agent handoff
5. Monitoring
- Resolution rate
- Accuracy score
- User feedbackFreshdesk Portal Customization
<!-- Freshdesk Portal Customization -->
<!-- Custom CSS location: Admin > General > Portal Customization -->
/* Hero section */
.solution-home-hero {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
padding: 80px 20px;
}
/* Category cards */
.solution-category-card {
border-radius: 12px;
transition: box-shadow 0.3s;
}
.solution-category-card:hover {
box-shadow: 0 8px 24px rgba(0,0,0,0.15);
}
/* Article styling */
.article-body {
font-size: 16px;
line-height: 1.7;
max-width: 720px;
}Freshdesk Best Practices
CONTENT ORGANIZATION
- Use tags for cross-category topics
- Enable article feedback
- Set up approval workflows
- Use draft mode for WIP content
AUTOMATION
- Auto-suggest articles in tickets
- Email notifications for feedback
- Scheduled content reviews
- Bulk operations for updates
FREDDY OPTIMIZATION
- Question-format titles
- Clear, concise answers
- Structured content (lists, tables)
- Regular content updatesGitBook Setup
Initial Configuration
SETUP CHECKLIST
1. Create space
- Documentation type
- Public or private
- Custom domain
2. Structure
- Groups (top-level)
- Pages (articles)
- Subpages (nested)
3. Customize
- Brand colors
- Custom fonts
- Logo
- Favicon
4. Integrations
- Git sync (GitHub/GitLab)
- Analytics (GA, Plausible)
- Search (Algolia)
5. Publishing
- Custom domain
- SSL certificate
- SEO settingsGit Sync Configuration
# .gitbook.yaml (repo root)
root: ./docs/
structure:
readme: README.md
summary: SUMMARY.md
redirects:
old-page: new-page
moved-article: articles/new-locationGitBook Customization
// space.json (GitBook configuration)
{
"title": "Product Documentation",
"description": "Help center for [Product]",
"theme": {
"extends": "@gitbook/theme-default",
"colors": {
"primary": "#1a73e8"
},
"font": "Inter"
},
"features": {
"search": true,
"feedback": true,
"pdf": false
}
}GitBook Best Practices
DOCS-AS-CODE WORKFLOW
1. Content in Markdown files
2. Version control (Git)
3. PR-based reviews
4. Automated deployment
STRUCTURE
- SUMMARY.md defines navigation
- Group related pages
- Use page variants for versions
- Inline code blocks for technical content
COLLABORATION
- Git sync for developers
- Web editor for non-technical
- PR reviews for quality
- Scheduled syncsNotion as Help Center
Setup for External Help Center
SETUP STEPS
1. Create workspace
- Dedicated workspace or section
- Clean, minimal structure
2. Build template
- FAQ database
- How-to template
- Category pages
3. Make public
- Share > Publish to web
- Custom domain (paid)
- Search engine indexing
4. Customize
- Cover images
- Icons
- Callout blocks
- Toggle blocks (FAQ)Notion Help Center Template
STRUCTURE
Help Center (Page)
|-- Getting Started
| |-- Quick Start Guide
| |-- Account Setup
| \\-- First Steps
|-- Features
| |-- Feature A Guide
| |-- Feature B Guide
| \\-- Feature C Guide
|-- Billing
| |-- Pricing FAQ
| |-- Payment Methods
| \\-- Refund Policy
|-- FAQ
| \\-- FAQ Database (toggle blocks)
\\-- Contact Us
\\-- Support form embedNotion Limitations
LIMITATIONS FOR HELP CENTER
- No built-in search analytics
- Limited customization
- No AI chatbot integration
- No ticket system
- Slow load times (vs dedicated)
- No offline access
WORKAROUNDS
- Use Super.so for better design
- Add Crisp/Intercom for chat
- Use Tally for feedback forms
- Third-party analytics (Plausible)
BEST FOR
- Early-stage startups
- Internal documentation
- Simple public docs
- Supplement to main help centerEnterprise AI Platforms (2026)
Salesforce Proactive Service AI
Salesforce's proactive AI detects and resolves customer issues before they're reported.
CAPABILITIES
1. Proactive Detection
- Monitor unified customer data
- Detect anomalies and issues
- Alert before customer reports
2. Autonomous Resolution
- Execute fixes automatically
- Send proactive communications
- Escalate only when necessary
3. Agent Assist
- AI-generated summaries
- Suggested next actions
- Full context at handoff
USE CASES
- Shipping delay -> Proactive notification + discount offer
- Payment failure -> Auto-retry + customer alert
- Product issue -> Preemptive replacement initiation
- Renewal risk -> Churn prevention outreach
INTEGRATION
- Requires Salesforce Service Cloud
- Unified data platform (CDP)
- MuleSoft for external systems
- Einstein AI license requiredGoogle Gemini Enterprise CX
Google's agentic commerce platform combines shopping and customer service.
CAPABILITIES
1. Agentic Commerce
- End-to-end customer lifecycle
- Product discovery to post-purchase
- Autonomous resolution
2. Pre-built Agents
- Deployable in days, not months
- Configurable without code
- Industry-specific templates
3. Integration
- Google Cloud ecosystem
- BigQuery for analytics
- Vertex AI for customization
USE CASES (Retail/E-commerce)
- Product recommendations -> Conversational discovery
- Order tracking -> Real-time updates + proactive alerts
- Returns processing -> Autonomous handling
- Customer feedback -> Sentiment analysis + routing
PRICING
- Google Cloud consumption-based
- Vertex AI API calls
- Contact sales for enterprise pricingServiceNow Knowledge Management
Enterprise-grade knowledge management with GenAI-powered content creation.
CAPABILITIES
1. AI Content Generation
- Auto-generate articles from closed incidents
- Summarize resolution steps
- Identify knowledge gaps
2. Enterprise Integration
- ITSM workflow integration
- Multi-department knowledge sharing
- Approval workflows
3. Security & Compliance
- SOC 2, ISO 27001, HIPAA
- Role-based access control
- Audit trails
BEST FOR
- Large enterprises (500+ employees)
- IT service management
- Regulated industries
- Complex multi-team environments
PRICING: Contact sales (enterprise only)Migration Guide
Platform Migration Checklist
MIGRATION STEPS
1. Pre-migration
- Audit current content
- Map categories to new structure
- Export all content (CSV/JSON)
- Document redirects needed
- Plan downtime (if any)
2. Content migration
- Import via API or CSV
- Update internal links
- Re-upload images
- Apply new templates
- Review formatting
3. Configuration
- Set up categories/sections
- Configure search
- Enable AI features
- Set up analytics
- Test all functionality
4. Launch
- Update DNS (custom domain)
- Set up redirects (301s)
- Monitor 404s
- Announce to users
- Train support team
5. Post-migration
- Monitor search analytics
- Check for broken links
- Gather user feedback
- Optimize based on dataContent Export Formats
EXPORT OPTIONS BY PLATFORM
Zendesk:
- CSV export (articles, categories)
- API (full content + metadata)
- Zendesk to Intercom migrator
Intercom:
- CSV export
- API export
- No native migrator
Freshdesk:
- Solution articles export
- API export
- CSV for bulk
GitBook:
- Git repo (full sync)
- PDF export
- API export
Notion:
- HTML export
- Markdown export
- No API export (limited)Redirect Setup
REDIRECT PATTERNS
Zendesk:
Settings > Guide > Search > Redirects
Intercom:
Settings > Help Center > Redirects
Freshdesk:
Admin > Support Channels > Redirects
GitBook:
.gitbook.yaml redirects section
Generic (server-level):
/old-path -> /new-path (301)
/old-category/* -> /new-category/* (wildcard)