如何與 Michele Wiedemer 一起編寫有用的幫助內容

已發表: 2020-10-28

什麼是幫助內容?

您不必成為技術作家來創建幫助人們使用您的產品的內容。 您的內容需要幫助您的客戶自助。

客戶教育內容可幫助客戶解決問題並執行他們需要的任務。 提供此內容是確保您的產品在客戶中取得成功的重要因素。

有多種方法可以創建有效的幫助資源,在這篇文章中,Michele Wiedemer 分享了她 20 年來創建、評估和改進面向客戶的幫助內容的知識。


您可以在這篇文章的頂部觀看有關此主題的視頻,收聽播客節目,點擊下面的播放,或繼續閱讀以了解更多信息……

什麼是客戶教育?

客戶教育正在幫助最終用戶成功使用您的產品。 Michele 創建有用的內容,賦予用戶使用產品完成任務的技能和動力。

教育客戶使他們能夠成功是任何有用內容的核心。 但 Michele 知道,幫助內容可能不僅僅是一個快速查找的文檔。

“我對有用的內容和培訓的交叉點非常感興趣。 對於其他類型的材料,無論是培訓還是營銷,甚至是在銷售過程中,您如何才能擁有此基線? 你怎麼能教人們他們需要知道的東西?”

每個人都應該知道如何編寫幫助內容嗎?

書面溝通技巧很重要,Michele 在她的 TechSmith Academy 課程“編寫有用的幫助”中詳細介紹了改進這些技巧的基礎知識。

但是,當涉及到幫助內容時,必須優先考慮你的寫作方式和寫作對象。 同情客戶的需求是您將如何創建有用的內容。

通過設計和創建僅服務於最終用戶的幫助內容,它將更加有效。 它需要是他們可以輕鬆處理並最終從中學習的文檔或工具。

“這是我真正希望人們從中得到的一件事,就是善解人意。”

人們在創建客戶教育內容時犯的錯誤

寫太多是人們在創建幫助內容時常犯的錯誤。

將整個主題縮減為兩句話似乎很愚蠢,但幫助內容少即是多。 分解和簡化流程是確保您的用戶能夠遵循您的內容試圖教給他們的內容的最佳方式。

如果您包含太多信息,最終用戶可能會難以找到問題的答案或學習新流程。

Michele 的建議是對您包含的信息保持批判性和選擇性。 首先畫出關鍵點並將它們按易於處理的順序排列。 然後考慮是否需要收集到的任何額外信息。 也許您根本不需要包含它。

創建較短的內容比創建較長的內容要困難得多。 然而,米歇爾有一個技巧可以幫助她消除不必要的信息。

“對我幫助很大的一件事是,一旦我開始製作教程視頻並自己進行旁白,我就會大聲朗讀出來。 一旦你大聲讀出來,你就會開始意識到,哇,我不需要那麼多字。 我可以這樣說更快。”

如何決定創建什麼類型的幫助內容

幫助內容的一些示例包括培訓指南、教學視頻、教程,甚至電子學習。 任何幫助用戶完成任務的內容都是客戶教育內容,但是您如何選擇創建哪種類型的內容呢?

米歇爾最好的建議是從定義你的目標開始。 在做出任何內容決定之前,請先了解您希望您的內容幫助用戶實現什麼。

“如果你真的很清楚你想要完成什麼,就可以更容易地找出你需要的正確產品。”

決定創建什麼類型的內容的另一個好方法是與用戶交談。 找出他們喜歡使用哪些類型的內容,或者哪些內容類型可以幫助他們解決問題。 畢竟,客戶教育內容只有在客戶使用它時才有用。

如何編寫幫助內容

一旦您了解了高級信息,例如您的目標和您的受眾,您就可以開始編寫您的客戶教育內容。 Michele 有一個創建內容的三步過程,並在她的寫作有用的幫助TechSmith 學院課程中詳細解釋了它。

第一步是決定寫什麼。 這包括選擇您需要涵蓋的主題以及您將要包括的所有內容。 Michele 建議從標題開始將信息分解為“塊”。

第一個塊應該是與用戶遇到的問題或痛點相關的基於操作的標題。 下一部分是“對我有什麼好處?” 聲明,它告訴讀者內容將幫助他們實現什麼。

其他塊包括使用地標來幫助用戶瀏覽內容、可操作的步驟以及增強讀者體驗和簡化流程的屏幕截圖或圖像。

第二步是讓您的內容在設計意義上易於閱讀。 您的內容需要看起來不錯並且可以掃描。 用戶需要能夠通過掃描文檔來快速查找信息。

您可以通過使用編號列表、項目符號、相關的粗體文本以及圖像等視覺標記來幫助實現這一目標。 這些視覺效果幫助用戶找到他們需要的東西,而不會陷入文本中。

第三步是讓您的內容易於查找。 考慮用戶如何找到您的內容並讓他們輕鬆到達那裡。

如果您的讀者找不到它,它可能不存在

無論這意味著針對搜索引擎優化它還是給它一個清晰的標題以便它可以在其他有用文檔的文件夾中脫穎而出,如果他們無法輕鬆訪問它,您的幫助內容將無法幫助任何人。

如果您的平台允許,Michele 提倡使用類別來分類和顯示您的幫助內容。 她強調,你應該組織你的內容以使其符合邏輯,以便人們知道如何尋找它。

Michele 還建議使用超鏈接來控制掉進信息兔子洞的感覺。 通過將超鏈接放入文檔並清楚地標記它們,用戶可以以有節制的方式在信息之間移動以了解更多信息。

“使用超鏈接的一種非常有效的方式是說,我在這裡只談論這一件事,這裡有所有其他相關的事情。”

同理心在有用的幫助內容中的重要性

如果你製作了好的內容,這將對搜索引擎和閱讀它的人有好處

Michele 的最終想法是關於什麼使幫助內容有效。 她的建議是確保您從同情的地方創建幫助內容。

您無需使用昂貴的特殊軟件讓用戶驚嘆。 這不是好的有用內容的原因。 最有用的幫助內容使用能夠有效傳達信息的軟件,無論是文本文檔還是屏幕截圖視頻。

雖然對您的內容進行 SEO 以幫助搜索引擎找到它很重要,並且使用屏幕截圖為用戶提供更多上下文可能是有益的,但所有這些塊應該結合起來創造一個有用的用戶體驗。

因此,當您創建幫助內容時,請設身處地為用戶著想,幫助您的客戶自助。

要了解有關創建更好的客戶教育內容的更多信息,請查看 TechSmith 學院的 Michele 課程,編寫有用的幫助:https://academy.techsmith.com