sometimes the best support means ge

sometimes the best support means getting out of your customer’s way.
A knowledge base can be a customer’s best friend during the “help me help myself” phase of exploring your product. But as Kathy Sierra shares in Making Users Awesome, companies often drop the ball with post-purchase publishing. Help content is usually one of the first things to feel the sting of mediocrity.

Help Scout Docs can put the beauty back into documentation, but clean, organized writing doesn’t come in the same turn-key fashion; it’ll take sincere effort.

You need to be informative, engaging, unquestionably clear, and mindful of how and why a customer searched for help in the first place.

Here are a few tips for doing exactly that.

Don’t Make Assumptions

Customers check your docs to solve problems. Your most important goal is to be impossible to misunderstand.

While expertise operates on a spectrum, you should write as if the customer is a beginning user of your product. Skip the advanced terminologies and jargon, and be wary of mentioning to-dos in passing; customers are likely to hit roadblocks there. It’s safer to assume that they’ll need guidance for each step.

An example:

If a customer is looking up how to migrate their website to a new host, which one of the following leaves the least room for error?
1, Before you continue, make sure to change your IP address.
2, Before continuing, change your IP address by going to Settings > Manage Domain > IP Address.
The latter. Don’t self-sabotage by making assumptions about “simple” instructions. It’s better to over-communicate.

Make Content Easy to Browse

Don’t bog down or intimidate readers with a wall of text—when solutions aren’t easy to find, contacting support will be the customer’s next step. That’s a failure to communicate and a frustration for both of you.

Designer Rafal Tomal shows below how proper use of sub-headings and line breaks are a shortcut to an easily scannable doc.

Use callouts, bullet points, spacing, and visuals to highlight important information and keep the full set of instructions visible at a glance.

Below is an example from our Workflows article that showcases most of these elements in action:
Tailor the experience around who you’re helping: a confused customer who is trying to pinpoint the section that solves his or her problem.

Make Content Easy to Read

For honing your voice in writing, one of the best resources on the web is MailChimp’s Voice and Tone. A few suggestions I would add:

Plain prose is not too far from talk, but also not too near. Speak as you would to a friend but use editing to dress your thoughts well.
Consider your readers’ goals—is the article about learning the ins-and-outs of your product (curious), or fixing a bug or problem (frustration)? Adjust your tone accordingly.
For articles on non-troubleshooting issues, a bit of humor is fine, but the line of annoyance is quickly crossed.
Avoid slang and anything borderline. I once saw a writer get chewed out over the word “gypped,” which they used not understanding its derogatory nature.
Get to the point. Nothing drags down your doc more than spreading important information over too many words.
All writing must be engaging to keep people reading, but don’t let solutions become lost in flowery prose, excessive “personality,” and meandering jokes.

Organize Your Articles Logically

Good documentation becomes great when it’s designed around the reader’s workflow.

Unless you want customers floundering about like a fish out of water assembling an IKEA TV stand, it pays to get the “flow” right. Here are three principles to live by:

Chronological order
As you might have guessed, it’s a must to organize a piece of help content in the chronological order of steps. The first thing customers should do must be Step 1.
Order by difficulty
If multiple tasks can be performed “first” (i.e., order doesn’t matter much), have customers do what’s easiest first. Early friction decreases the likelihood that they’ll finish or even follow your advice, so begin with a win.
Be mindful of workflow
We all recognize that if you link someone to a video a few paragraphs into your doc, you increase the chances they’ll get distracted. Structure responses in a way that sustains activity and momentum. Avoid interrupting a problem-solving workflow until near the end.
Similar to constructing a great support email, place links strategically in sections to nudge customers into clicking them only when ready.

When introducing a longer article, create a quick table of contents at the beginning; it’s a small effort that genuinely enhances the experience. Even for articles of normal length, customers will appreciate being able to jump to the section they want.
How about ending help content? Put yourself in the customer’s shoes and consider this monologue: “Okay, I’m ready to do this. Oh wait, what about…”

Kết quả (Việt) 1:

đôi khi sự hỗ trợ tốt nhất có nghĩa là nhận được ra khỏi con đường của khách hàng.Một kho tàng kiến thức có thể là người bạn tốt nhất của khách hàng trong giai đoạn "giúp tôi giúp bản thân mình" để khám phá sản phẩm của bạn. Nhưng như Kathy Sierra cổ phiếu ở việc người dùng tuyệt vời, công ty thường thả bóng với Post-mua đăng. Nội dung Trợ giúp thường là một trong những điều đầu tiên để cảm thấy sting của mediocrity.Trợ giúp Docs & Spreadsheets hướng đạo có thể đưa vẻ đẹp trở lại tài liệu, nhưng sạch sẽ, tổ chức viết không đi vào chìa cùng thời trang; nó sẽ mất nỗ lực chân thành.Bạn cần phải được thông tin, hấp dẫn, rõ ràng và nghĩ đến như thế nào và tại sao một khách hàng tìm kiếm sự giúp đỡ ở nơi đầu tiên.Dưới đây là một số mẹo để làm chính xác điều đó.Đừng giả địnhKhách hàng kiểm tra tài liệu của bạn để giải quyết vấn đề. Mục tiêu quan trọng nhất của bạn là không thể hiểu sai.Trong khi chuyên môn hoạt động trên một phổ, bạn nên viết, nếu như khách hàng là người bắt đầu dùng sản phẩm của bạn. Bỏ qua việc nâng cao ngữ và biệt ngữ, và hãy cảnh giác với đề cập đến cho qua; khách hàng có khả năng trúng rào chắn đó. Nó là an toàn để giả định rằng họ sẽ cần phải hướng dẫn từng bước.Ví dụ:Nếu một khách hàng tìm ra làm thế nào để di chuyển các trang web của họ tới một máy chủ mới, mà một trong những điều sau đây lá phòng ít nhất là cho các lỗi?1, trước khi bạn tiếp tục, hãy chắc chắn để thay đổi địa chỉ IP của bạn.2, trước khi tiếp tục, thay đổi địa chỉ IP của bạn bằng cách đi tới cài đặt > quản lý tên miền > địa chỉ IP.Sau này. Đừng tự phá hoại bằng cách làm cho các giả định về hướng dẫn "đơn giản". Nó là tốt hơn để giao tiếp hơn.Làm cho nội dung dễ dàng để duyệtKhông bog xuống hoặc đe dọa các độc giả với một bức tường của văn bản-khi giải pháp không phải là dễ dàng để tìm thấy, liên lạc với hỗ trợ sẽ có bước tiếp theo của khách hàng. Đó là một sự thất bại để giao tiếp và sự thất vọng cho cả hai của bạn.Thiết kế Rafal Tomal cho thấy dưới đây làm thế nào thích hợp sử dụng các đề mục phụ và dòng phá vỡ một phím tắt cho một tài liệu một cách dễ dàng scannable.Sử dụng mô tả, điểm đạn, khoảng cách và hình ảnh để làm nổi bật thông tin quan trọng và giữ tập hợp đầy đủ các hướng dẫn có thể nhìn thấy trong nháy mắt.Dưới đây là một ví dụ từ phần công việc của chúng tôi giới thiệu hầu hết những yếu tố này trong hành động:Chỉnh kinh nghiệm xung quanh những người bạn đang giúp đỡ: một khách hàng nhầm lẫn người đang cố gắng để xác định các phần giải quyết vấn đề của mình.Làm cho nội dung dễ dàng để đọcĐể hoàn thiện các giọng nói của bạn bằng văn bản, một trong các nguồn lực tốt nhất trên web là MailChimp của giọng nói và giai điệu. Một vài gợi ý tôi sẽ thêm:Văn xuôi đồng bằng không quá xa từ nói chuyện, nhưng cũng không quá gần. Nói chuyện như một người bạn nhưng sử dụng chỉnh sửa để ăn suy nghĩ của bạn tốt.Xem xét các mục tiêu của bạn độc giả — là bài viết về học tập in outs của sản phẩm của bạn (tò mò), hoặc sửa chữa một lỗi hay vấn đề (thất vọng)? Điều chỉnh giai điệu của bạn cho phù hợp.Đối với các bài viết về phòng không giải đáp thắc mắc các vấn đề, một chút hài hước là tốt, nhưng dòng của ít phiền toái một cách nhanh chóng vượt qua.Tránh tiếng lóng và bất cứ điều gì đường biên giới. Tôi một khi đã thấy một nhà văn có được nhai qua từ "gypped," mà họ sử dụng không hiểu bản chất của nó xúc phạm.Nhận được điểm. Không có gì kéo xuống của bạn bác sĩ nhiều hơn việc truyền bá thông tin quan trọng trên quá nhiều từ.Tất cả văn bản phải tham gia để giữ cho người đọc, nhưng không cho giải pháp trở nên mất đi trong văn xuôi nhiều hoa, quá nhiều "nhân", và vòng vo cười.Tổ chức các bài viết của bạn một cách hợp lýTốt tài liệu trở nên rất lớn khi nó được thiết kế xung quanh quy trình làm việc của người đọc.Trừ khi bạn muốn khách floundering về giống như một cá ra khỏi nước lắp ráp một TV IKEA đứng, nó trả tiền để có được "dòng chảy" ngay. Dưới đây là ba nguyên tắc sống của:Thứ tự thời gianNhư bạn có thể đoán, đó là phải để tổ chức một mảnh của nội dung Trợ giúp theo thứ tự các bước. Lần đầu tiên khách hàng nên làm gì phải bước 1.Tự do khó khănNếu nhiều tác vụ có thể được thực hiện "đầu tiên" (tức là, đặt hàng không quan trọng nhiều), có khách hàng làm những gì là dễ nhất đầu tiên. Đầu ma sát làm giảm khả năng họ sẽ kết thúc hoặc thậm chí thực hiện theo lời khuyên của bạn, vì vậy bắt đầu với một chiến thắng.Được lưu tâm của công việcTất cả chúng ta nhận ra rằng nếu bạn liên kết một ai đó với một video một vài đoạn văn vào tài liệu của bạn, bạn tăng cơ hội mà họ sẽ nhận được bị phân tâm. Cấu trúc các phản ứng trong một cách mà duy trì hoạt động và động lực. Tránh gián đoạn công việc giải quyết vấn đề cho đến khi gần kết thúc.Tương tự như xây dựng một hỗ trợ tuyệt vời email, nơi liên kết chiến lược trong phần để di chuyển khách vào cách nhấp vào họ chỉ khi sẵn sàng.Khi giới thiệu một bài viết dài hơn, tạo ra một bảng nội dung nhanh chóng đầu; đó là một nỗ lực nhỏ mà thực sự tăng cường kinh nghiệm. Thậm chí cho bài viết của chiều dài bình thường, khách hàng sẽ đánh giá cao việc có thể để chuyển đến phần mà họ muốn.Làm thế nào về kết thúc nội dung Trợ giúp? Đặt mình trong đôi giày của khách hàng và xem xét độc thoại này: "được rồi, tôi đã sẵn sàng để làm điều này. Oh chờ đợi, những gì về..."

Kết quả (Việt) 2:

đôi khi sự hỗ trợ tốt nhất có nghĩa là nhận ra khỏi con đường của khách hàng của bạn.
Một cơ sở kiến thức có thể là người bạn tốt nhất của một khách hàng trong suốt "giúp tôi tự giúp mình" giai đoạn khám phá sản phẩm của bạn. Nhưng như Kathy Sierra cổ phiếu trong Làm Người dùng Awesome, các công ty thường thả bóng với xuất bản bài mua. Nội dung trợ giúp thường là một trong những điều đầu tiên cảm thấy sting của kẻ tầm thường. Giúp Scout Docs có thể đưa vẻ đẹp trở thành tài liệu, nhưng sạch sẽ, được tổ chức bằng văn bản không đi kèm trong cùng thời trang chìa khoá; nó sẽ mất sức chân thành. Bạn cần để được thông tin, tham gia, không nghi ngờ gì rõ ràng, và chánh niệm như thế nào và tại sao một khách hàng tìm kiếm sự giúp đỡ ở nơi đầu tiên. Dưới đây là một vài lời khuyên cho việc làm chính xác điều đó. Đừng Làm giả định Khách hàng kiểm tra tài liệu của bạn để giải quyết vấn đề. Mục tiêu quan trọng nhất của bạn là người không thể hiểu lầm. Trong khi chuyên môn hoạt động trên một quang phổ, bạn nên viết như nếu khách hàng là người mới bắt đầu của sản phẩm của bạn. Bỏ qua những thuật ngữ cao cấp và biệt ngữ, và được cảnh giác nhắc đến to-dos trong đi qua; khách hàng có khả năng để đạt rào chắn ở đó. Nó an toàn để giả định rằng họ sẽ cần hướng dẫn cho mỗi bước. Một ví dụ: Nếu một khách hàng đang tìm lên như thế nào để di chuyển trang web của họ đến một máy chủ mới, mà một trong những điều sau đây chỉ rời khỏi phòng ít nhất là cho lỗi 1, Trước khi tiếp tục , hãy chắc chắn để thay đổi địa chỉ IP của bạn. 2, Trước khi tiếp tục, thay đổi địa chỉ IP của bạn bằng cách vào Settings> Quản lý tên miền> IP Address. Loại thứ hai. Đừng tự phá hoại bằng cách làm cho các giả định về "đơn giản" hướng dẫn. Nó tốt hơn để qua giao tiếp. Làm cho nội dung dễ dàng để Browse Đừng sa lầy hoặc đe dọa độc giả với một bức tường của văn bản khi giải pháp này là không dễ dàng để tìm kiếm, liên hệ với hỗ trợ sẽ là bước tiếp theo của khách hàng. Đó là một sự thất bại để giao tiếp và một sự thất vọng cho cả hai bạn. Designer Rafal Tomal lãm dưới đây cách thích hợp sử dụng các phân nhóm và dòng ngắt là một shortcut của một doc dễ dàng quét được. Sử dụng các callout, điểm nhấn, khoảng cách, và hình ảnh để làm nổi bật quan trọng thông tin và bảo tập các hướng dẫn có thể nhìn thấy trong nháy mắt. Dưới đây là một ví dụ từ bài viết của chúng tôi quy trình công việc mà giới thiệu hầu hết các yếu tố trong hành động: Tailor kinh nghiệm xung quanh những người bạn đang giúp đỡ: một khách hàng nhầm lẫn những người đang cố gắng để xác định phần mà giải quyết vấn đề của mình. Làm cho nội dung dễ đọc Đối mài giũa giọng nói của bạn bằng văn bản, một trong những nguồn lực tốt nhất trên web là Voice và Tone MailChimp của. Một vài gợi ý tôi muốn nói thêm: văn xuôi đồng bằng không quá xa từ nói chuyện, nhưng cũng không quá gần. Nói như bạn sẽ đến một người bạn nhưng sử dụng chỉnh sửa để mặc những suy nghĩ của bạn tốt. Hãy xem xét của người đọc mục tiêu-là bài ​​viết về việc học các ins-and-outs của sản phẩm của bạn (tò mò), hoặc sửa chữa một lỗi hoặc vấn đề (thất vọng)? Điều chỉnh giai điệu của bạn cho phù hợp. Đối với các bài viết về các vấn đề không xử lý sự cố, một chút hài hước là tốt, nhưng dòng của ít phiền toái là nhanh chóng vượt qua. Tránh tiếng lóng và bất cứ điều gì biên giới. Tôi đã từng chứng kiến một nhà văn được nhai ra trên chữ "gypped," mà họ đã sử dụng không hiểu được bản chất của nó xúc phạm. Nhận điểm. Không có gì kéo xuống doc của bạn nhiều hơn truyền bá thông tin quan trọng hơn quá nhiều từ. Tất cả văn bản phải được tham gia để giữ cho mọi người đọc, nhưng đừng để các giải pháp trở thành bị mất trong văn xuôi hoa, quá "cá tính", và uốn khúc câu chuyện cười. Tổ chức các bài viết của bạn Logic tài liệu tốt trở nên tuyệt vời khi nó được thiết kế xung quanh công việc của người đọc. Trừ khi bạn muốn khách hàng lúng túng về giống như một con cá ra khỏi nước lắp ráp một TV đứng IKEA, nó trả tiền để có được những "dòng chảy" ngay. Dưới đây là ba nguyên tắc để sống: Để Chronological Như bạn có thể đoán, đó là phải tổ chức một phần nội dung giúp đỡ trong thứ tự thời gian của các bước. Điều đầu tiên khách hàng nên làm phải được Bước 1. Đặt hàng bằng khó khăn Nếu nhiều nhiệm vụ có thể được thực hiện "đầu tiên" (tức là, trật tự không quan trọng nhiều), có khách hàng làm những gì đơn giản nhất đầu tiên. Ma sát sớm làm giảm khả năng họ sẽ kết thúc hoặc thậm chí làm theo lời khuyên của bạn, vì vậy bắt đầu với một chiến thắng. Quan tâm đến công việc Chúng ta đều nhận ra rằng nếu bạn liên kết một người nào đó đến một video một vài đoạn văn vào doc của bạn, bạn sẽ làm tăng cơ hội họ ll được phân tâm. Đáp ứng cơ cấu một cách để duy trì hoạt động và động lực. Tránh làm gián đoạn một tiến trình công việc giải quyết vấn đề cho đến khi gần kết thúc. Tương tự như xây dựng một email hỗ trợ tuyệt vời, địa điểm liên kết chiến lược trong các phần để di chuyển khách hàng vào cách nhấp vào chúng chỉ khi đã sẵn sàng. Khi giới thiệu một bài viết dài hơn, tạo ra một bảng nhanh chóng của các nội dung ở đầu ; đó là một nỗ lực nhỏ đó thực sự nâng cao kinh nghiệm. Ngay cả đối với các bài viết của chiều dài bình thường, khách hàng sẽ đánh giá cao việc có thể nhảy đến phần họ muốn. Làm thế nào về kết thúc nội dung trợ giúp? Đặt mình vào vị trí của khách hàng và xem xét độc thoại này: "Được rồi, tôi đã sẵn sàng để làm điều này. Oh chờ đợi, những gì về ... "