diff --git a/docs.json b/docs.json index dc55460cb..790425b1f 100644 --- a/docs.json +++ b/docs.json @@ -335,7 +335,7 @@ "pages": [ "guides/developer-documentation", "guides/knowledge-base", - "guides/support-center", + "guides/help-center", "guides/custom-frontend" ] } @@ -1676,6 +1676,10 @@ ] }, "redirects": [ + { + "source": "/guides/support-center", + "destination": "/guides/help-center" + }, { "source": "/content/components/accordions", "destination": "/components/accordions" diff --git a/guides/support-center.mdx b/guides/help-center.mdx similarity index 67% rename from guides/support-center.mdx rename to guides/help-center.mdx index c7f8c875d..4a8469923 100644 --- a/guides/support-center.mdx +++ b/guides/help-center.mdx @@ -1,30 +1,42 @@ --- -title: "Create a support center" -sidebarTitle: "Support center" -description: "Build a self-service support center on Mintlify that helps customers find answers, reduces support ticket volume, and improves satisfaction." -keywords: ["support center", "help center", "customer support", "self-service", "FAQ"] +title: "Create a help center" +sidebarTitle: "Help center" +description: "Build a help center on Mintlify that helps customers find answers, reduces support ticket volume, and improves user satisfaction." +keywords: ["support", "customer", "self-service", "FAQ"] --- -A support center helps customers solve problems and find information about your product. When customers can find answers themselves, they get help faster and your support team can focus on complex issues that require their expertise. +A help center helps customers troubleshoot and find information about your product. When customers can find answers themselves, they get help faster and your support team can focus on complex issues that require their expertise. -Mintlify provides infrastructure for support centers that scale with your customer base. +Mintlify provides infrastructure for help centers that scale with your customer base. -- **AI-powered search**: The [assistant](/ai/assistant) answers customer questions using your support content, so people can find answers without knowing exactly where to look or specific terms to search for. +- **AI-powered search**: The [assistant](/ai/assistant) answers customer questions using your support content, so people can get answers quickly without knowing exactly where to look or specific terms to search for. - **Feedback collection**: Built-in [feedback widgets](/optimize/feedback) let customers rate articles and report issues so you can improve content. -- **Analytics**: Track which articles get views, what questions customers ask, and where they struggle. +- **Analytics**: Track which articles get views, what questions customers ask, and where they struggle in the [analytics dashboard](/optimize/analytics). - **Authentication**: Use [SSO or OAuth](/deploy/authentication-setup) to show personalized content based on customer plans or account types. +## Start from a template + +The fastest way to create a new help center is with the `mint new --template` command. Run the command and select the help center starter template. + +```bash +mint new your-help-center-name --template help-center-starter +``` + +This creates a new project pre-configured for a help center, including navigation structure, sample pages, and directory listings. See the [live example](https://help-center-starter.mintlify.app/) or browse the [template source](https://github.com/mintlify/templates/tree/main/help-center-starter). + +If you prefer to configure a help center in an existing project, continue with the steps below. + ## Prerequisites If you haven't created a Mintlify project yet, see the [Quickstart](/quickstart) to deploy your site. - Content for your most common support topics - Admin access to your Mintlify organization -- Domain for hosting your support center +- Domain for hosting your help center ## Migrate existing content -If you're creating a support center from scratch, skip to [Plan your support center structure](#plan-your-support-center-structure). +If you're creating a help center from scratch, skip to [Plan your help center structure](#plan-your-help-center-structure). ### Audit existing content @@ -41,20 +53,26 @@ Review your current support resources to understand what to migrate. - Export to **HTML** if Markdown isn't available, then convert to Markdown. - Export **ticket data** to identify common questions that need documentation. -## Plan your support center structure +## Plan your help center structure -Organize your support center around customer problems, not product features. Customers arrive with questions and goals, so structure content that aligns with how they think about your product and common tasks. +Organize your help center around customer problems, not product features. Customers arrive with questions and goals, so structure content that aligns with how they think about your product and common tasks. Review your support tickets to understand what customers actually ask about. This helps you prioritize content and structure navigation around real problems. -```json +Use the `directory` property to create index pages for each group in your navigation. When you use the `directory` property, every `root` page displays a directory listing for the other pages in the same navigation group. This gives customers an overview of the content in each section that they can click through to the specific pages they need. + +Set `directory` to `"card"` for a horizontal card layout or `"accordion"` for a list. The value passes down through the navigation tree unless you specifically override it on a later level. + +```json Example navigation structure { "navigation": { + "directory": "card", "groups": [ { "group": "Get Started", + "root": "getting-started/index", "pages": [ "getting-started/quick-setup", "getting-started/first-steps" @@ -62,6 +80,7 @@ Organize your support center around customer problems, not product features. Cus }, { "group": "Account", + "root": "account/index", "pages": [ "account/billing", "account/plans", @@ -71,6 +90,7 @@ Organize your support center around customer problems, not product features. Cus }, { "group": "Using the Product", + "root": "product/index", "pages": [ "product/feature-one", "product/feature-two", @@ -79,6 +99,7 @@ Organize your support center around customer problems, not product features. Cus }, { "group": "Troubleshooting", + "root": "troubleshooting/index", "pages": [ "troubleshooting/common-errors", "troubleshooting/connectivity", @@ -90,7 +111,7 @@ Organize your support center around customer problems, not product features. Cus } ``` -See [Navigation](/organize/navigation) for more configuration options. +See [Navigation](/organize/navigation) and [Directory listings](/organize/navigation#directory-listings) for more configuration options. ## Write effective support content @@ -183,7 +204,7 @@ Feedback helps you understand which pages are helpful and which need improvement ## Set up analytics -Monitor how customers use your support center to improve content over time. +Monitor the [analytics](/optimize/analytics) in your dashboard to see how customers use your help center and improve content over time. - **Popular articles**: Which articles get the most views? Keep these accurate and well-maintained. - **Search queries**: What do customers search for? Create content for common searches that return no results. @@ -195,7 +216,7 @@ If you have different customer tiers or product plans, show relevant content to - Configure [authentication](/deploy/authentication-setup) to identify customers when they visit your support center. + Configure [authentication](/deploy/authentication-setup) to identify customers when they visit your help center. @@ -214,7 +235,7 @@ If you have different customer tiers or product plans, show relevant content to -## Maintain your support center +## Maintain your help center Support content becomes outdated as your product changes. Establish processes to keep content accurate. @@ -228,21 +249,21 @@ Support content becomes outdated as your product changes. Establish processes to - If customers submit tickets for issues covered in your support center, investigate why self-service didn't work. The article might be hard to find, unclear, or incomplete. + If customers submit tickets for issues covered in your help center, investigate why self-service didn't work. The article might be hard to find, unclear, or incomplete. - Remove or archive articles about deprecated features. Outdated content confuses customers and reduces trust in your support center. + Remove or archive articles about deprecated features. Outdated content confuses customers and reduces trust in your help center. ## Next steps -Your support center is ready to launch. After deploying: +Your help center is ready to launch. After deploying: -1. Link to your support center from your product and website. +1. Link to your help center from your product and website. 2. Monitor assistant conversations and search queries to find content gaps. 3. Review feedback ratings weekly and improve low-rated articles. 4. Track ticket volume to measure self-service effectiveness. -A good support center reduces support costs while improving customer satisfaction. Invest in content that answers common questions effectively. +A good help center reduces support costs while improving customer satisfaction. Invest in content that answers common questions effectively.