如何編寫入門指南：初學者指南！

第一印像很重要。當用戶第一次嘗試您的產品時，精心製作的入門指南可以使一切與眾不同。

這是友好的導遊歡迎新用戶，向他們展示繩索，並為他們提供成功。

在本指南中，我將探討有關創建有效入門指南的所有信息。從其目的和關鍵要素到編寫技巧，示例和模板。

為什麼要打擾？明確的入門指南通常是登機的基石。它使用戶能夠自我服務，減少基本支持問題，並建立對您產品的信心和信任。

準備潛水了嗎？讓我們開始吧！

我們嚴格測試和研究我們通過赫洛塞姆推薦的每種產品。我們的審查過程。如果您通過我們的鏈接進行購買，我們也可能會賺取佣金。

什麼是入門指南？

入門指南是一個簡潔，用戶友好的文檔（印刷或數字），可幫助新用戶成功使用產品或服務。

將其視為初學者的手冊，專注於必需品。它通常涵蓋初始設置步驟，用戶應首先嘗試的基本功能或任務，以及避免常見陷阱的提示。

目標是讓用戶進入他們的“啊哈！”盡快。

實際上，入門指南提供了基本的設置說明（通常是分步格式），簡單的用法示例，以及一些有關即時問題的故障排除提示。

它向用戶展示瞭如何立即從產品中獲得價值。最初的手持量對於減少挫敗感並鼓勵用戶進一步探索有很長的路要走。

簡而言之，這是產品手冊友好的小兄弟姐妹- 專注於激光，以幫助用戶紮根。

入門指南有多種形式：

• 對於軟件，這可能是在線幫助中的歡迎教程或“入門”部分。
• 對於物理小工具，它可能是一個小折疊的快速啟動指南小冊子或盒子中的表（通常伴隨完整的手冊供以後參考）。

關鍵是它可以理解和訪問。用清晰的語言編寫，假設先驗知識最少，並且通常包括視覺效果以說明要點。

入門指南的目的

為什麼要創建入門指南？簡而言之，它的目的是使任何新產品具有陡峭的學習曲線。

以下是入門指南的一些主要好處和目的：

1。引導用戶通過初始設置

每種產品都有獨特的怪癖，可以讓初次用戶不知所措。入門指南會逐步通過初始設置或安裝，因此他們不會首先猜測該怎麼做。

這項直接指導可以快速滿足，用戶感到“很棒，我已經有效！”而不是“我不知道從哪裡開始”。積極的第一經驗可以將忠誠的用戶與早期放棄的用戶區分開。

2。減輕支持負擔

當有明確的說明時，用戶更喜歡自助。一個好入門指南迴答了基本的“我如何……？”問題，因此用戶無需聯繫有關簡單問題的支持。

這種自助服務不僅使用戶更加快樂，還可以減輕支持團隊的負擔。

您的指南成為第一條支持，處理簡單的東西並釋放團隊以解決更複雜的問題。

3。建立信心和信任

從新工具開始可能會令人生畏。溫和的介紹鼓勵用戶探索功能而不是迴避。

通過突出一些核心功能並顯示如何使用它們，該指南邀請用戶玩耍並發現價值。

這就像給他們訓練輪一樣，他們有信心自行騎行。這鼓勵您更深入地與您的產品互動，並可以將休閒用戶轉換為權力用戶或忠實客戶。

4。縮短學習曲線

使用新應用或設備時，沒有人喜歡感到愚蠢。

入門指南通過以易於管理的步驟進行教學來使學習曲線保持淺。

用戶首先學習基礎知識，然後逐漸解決高級功能。這種逐步方法可以防止陡峭的學習曲線會引起的壓倒性。

結果：用戶堅持使用更長的時間，而不是出於挫敗感。

5。標準化入職

從組織的角度來看，入門指南可確保每個新客戶都會收到一致的入職信息。

這是您最好與每個用戶一起前進的機會。

對於SaaS公司或軟件團隊來說，這也是一種早期展示重要功能或最佳實踐的方式。

就實物產品而言，它可以涵蓋安全警告或設置預防措施，因此用戶不會錯過它們。

入門指南的目的是增強用戶能力。在那裡說： “我們知道您是新手。這正是如何開始使用該產品。”

做得好後，它為用戶提供積極的持續體驗奠定了基礎。

在入門指南中包括什麼

那麼，一個很棒的入門指南是什麼呢？

儘管細節因產品而異，但最有效的指南具有共同的結構和成分。您可以將其視為一個簡單的食譜：

1。簡短概述或歡迎

從簡短的介紹開始，該簡介告訴用戶本指南將幫助他們完成什麼。

預先設定期望。例如，一兩個句子可能會解釋： “本指南將幫助您安裝該應用程序並在5分鐘內發送第一條消息。”

保持非常簡潔。用戶可能想快速潛水。您可能會列出他們將要完成的主要步驟或部分。概述本質上回答： “我將在本指南中學到什麼？”

這有助於激勵用戶跟隨，因為他們知道最終目標。 （這也是祝賀他們選擇您的產品的好地方 - 積極性永遠不會受傷！）

2。初始任務的分步說明

該指南的核心是針對最重要的入門任務的清晰，逐步的教程。

這通常包括安裝或設置，帳戶創建或登錄，以及在軟件/服務中執行第一個基本操作（或設備的基本操作）。

以邏輯順序提供說明，並保持每個步驟咬合大小和麵向動作。

編號列表是您的朋友。每個步驟都應說出該怎麼做以及如何做到這一點，而沒有歧義。

例如：“1。下載應用程序：訪問explay.com/download並單擊“安裝”。2。創建您的帳戶：打開應用程序並填寫註冊表格……”，等等。

如果步驟太複雜或長時間，請考慮將其分解為子步驟或簡化任務。經驗法則：每個步驟一個明確的行動。

3。屏幕截圖或視覺輔助工具

當您看到所描述的內容時，遵循說明要容易得多。

出色的入門指南包括相關圖像：軟件接口的屏幕截圖，硬件設置的照片或圖表，甚至是小的GIF/視頻，以進行棘手的步驟。

例如，如果步驟3是“單擊設置圖標”，則顯示帶有設置圖標或突出顯示的設置圖標的屏幕快照。

4。關鍵功能突出顯示或下一步

一旦完成基本設置，入門指南通常會簡要指出“下一步” 。

這可能是一個簡短的部分，例如“探索下一步”或“嘗試嘗試的關鍵功能” 。

這個想法是介紹一些最重要的功能或用戶在初始設置後應做的事情。

5。鏈接到進一步的資源和支持

一個好的入門指南認識到其範圍，它涵蓋了基礎知識，但是有些用戶會有更多問題。

始終為需要更多幫助的人提供簡單的途徑。

這可能是最終段落或框： “需要更多詳細信息？請參閱用戶手冊以進行高級設置和故障排除。”或“訪問我們的知識庫獲取有關每個功能的詳細文章”。包括指向您的文檔網站，常見問題解答，視頻教程，社區論壇的鏈接 - 無論您擁有什麼支持渠道。

對於物理產品，您可以參考完整的印刷手冊或支持電話號碼。

目的是向用戶保證，如果快速指南中未涵蓋某些內容，則可以找到答案。

此外，鼓勵他們與指南未解決的任何問題聯繫客戶支持。

通過預先共享文檔並支持資源，您可以平整整個入職經驗。用戶知道，如果他們卡住了，超越了第一步。

可以根據您的指南是單頁快速參考，簡短小冊子還是交互式在線教程進行調整。

核心想法是將其集中在初學者的需求上。

正如技術作家所說：

不要以為用戶已經知道任何東西- 在他們的水平上會見他們。

最後，格式可以大大變化。

• 為指南的每個部分使用清晰的標題（以便用戶可以輕鬆瀏覽或返回部分）。
• 子彈點和編號步驟可提高掃描性與長段落。
• 在數字指南中，您甚至可以為每個步驟將內容分解為選項卡或可折疊部分。
• 該指南應該一眼易於閱讀 - 友好而不是壓倒性的。
• 許多成功的指南甚至包括每個步驟或清單的複選框，因此用戶在進步時會感到成就感。

它在眼睛和大腦上越容易；用戶越可能遵循。

入門指南模板（概述示例）

讓我們將上面的內容固化為具體的模板。以下是您可以適應您的需求的通用入門指南模板結構。

為了例如，該模板假定數字軟件產品，但是您也可以調整物理產品的概念。將其用作起點：

此模板有意簡單。實際上，您可能會根據上下文結合或省略某些部分。

例如，某些指南將“下一步”提示集成為標註框或主要步驟旁邊的側面註釋。

物理快速啟動指南通常沒有明確的“下一步” - 相反，它們嚴格堅持設置，然後說“請參閱用戶手冊以獲取操作說明”。

另一個提示：保存模板並重複使用以保持一致性。如果您製作多個入門指南（例如，對於不同的產品線或針對不同的用戶角色），則具有標準輪廓確保所有指南都具有熟悉的感覺。

需要一個平台來託管和組織所有這些指南嗎？

嘗試英雄知識基礎，以創建美麗，可搜索的文檔網站。

這樣，您的入門指南可以與您的常見問題解答，教程和其他幫助文章一起生活。它還可以輕鬆更新內容，跟踪用戶搜索的內容並不斷改進您的文檔。

從英雄知識基礎開始

入門指南寫作提示

撰寫入門指南是一部分藝術和一部分科學。

您需要技術寫作的清晰度，客戶支持的同理心以及少量的營銷熱情 - 所有這些都以與讀者聯繫的對話語調包裹。

以下是一些撰寫指南時要牢記的主要技巧：

1。使用簡單的，無術的語言

請記住，許多讀者是完整的初學者。寫作好像您正在向沒有背景知識的人解釋您的產品域。

除非您絕對必須使用它們（然後用簡單的語言定義），否則避免行業行話或首字母縮寫詞。

簡單是關鍵。

例如，不要說“初始化配置參數”；說“設置您的基本設置。”清晰的日常單詞。

如果您必須包含一個技術術語（例如您的產品是API，並且需要提及“ API密鑰”），請提供簡短的解釋或類比。

一個好訣竅是讓某人不熟悉您的產品草稿，如果他們對任何句子感到困惑，請對其進行修改。

指南不是炫耀詞彙的地方。這是關於溝通的。語氣應該是友好而令人鼓舞的，就像一個有用的同事指導用戶一樣。

2。直接並以動作為導向

入門指南應以當務之急。本質上，您正在指示用戶做什麼。

在您的步驟中使用主動語音並帶有動詞（例如，“單擊下一步要繼續”，而不是“下一個按鈕應單擊”）。這使指示清晰。

另外，將句子簡短而專注。漫長而蜿蜒的句子可能會失去一個初學者。針對每個句子的一個想法，甚至在適當的情況下使用片段進行說明（“選擇文件>導入。選擇數據文件。單擊“打開”。” - 如果在這些情況下不是完整的正式句子，則可以）。

瞄準大約80歲左右的驗收分數，大約是6年級的閱讀水平，這非常適合廣泛的可訪問性。

這通常意味著較短的句子和通用單詞。

不用擔心，您的指南聽起來不會“愚蠢”，這聽起來很清楚。

清晰度是一種專業美德！

3。保持邏輯流

在自然順序上構建您的說明，新用戶需要做事。

例如，如果有關鍵序列，則必須在導入數據之前創建一個帳戶，請確保指南清楚地反映了該順序。

用戶永遠不必跳來跳去或執行心理體操才能跟隨您。

編號的步驟執行邏輯序列。

此外，使用標題和小標題將指南分解為可消化的部分（設置，首次使用，下一步）。

這不僅可以幫助用戶，而且可以改善SEO，因為搜索引擎可以更好地識別內容層次結構和關鍵字。

邏輯流也可能意味著以明智的順序介紹概念 - 例如，在告訴用戶創建一個“項目”之前定義“項目”是什麼。

如果您發現自己需要提前解釋太多，請考慮是否屬於單獨的“概念”文檔而不是QuickStart。

4。顯示，不要只是告訴

我們較早地談到了視覺效果，但它具有重複：在可能的情況下，向用戶展示該怎麼做，而不僅僅是告訴他們。

這可以通過屏幕截圖，圖表，甚至是嵌入式的簡短視頻或動畫作為在線指南。

視覺學習者會感謝您。

例如，您可以在“設置菜單”中使用，而是包含UI的微小圖像，並指向“設置齒輪圖標”的箭頭 - 現在的歧義為零。

同樣，使用標註框或註釋突出顯示UI元素。

Slack的用戶指南通過標記界面的一部分來幫助用戶定向自己，從而做得很好。

如果您要記錄物理產品，清晰的線圖或每個步驟的照片（例如，顯示如何將SIM卡插入手機中）非常有用。

確保您的視覺效果高質量並適當尺寸。模糊或微小的圖像比他們幫助的更多。並始終將視覺效果與文本聯繫起來，以便用戶知道他們在看什麼。

5。介意用戶的觀點

將自己放在新用戶的鞋子上。他們想實現什麼？他們每一步都會感覺到什麼？

解決這些。

有時，初學者甚至可能不知道為什麼他們必須邁出一步。簡短的理由可以幫助您，例如“此步驟確保您的數據正確同步”，如果它增加了清晰度。

另外，請注意假設：不要假設他們知道某個按鈕在哪里或術語是第一次曝光的含義。

如果您的指南是針對略有技術受眾（例如開發人員）的，則可能會假設一些知識（例如命令行基礎知識），但要闡明新開發人員可能不知道的任何內容。

對於更廣泛的受眾來說，在解釋（用簡單的話）方面而不是留出差距。

一種策略是快速進行用戶研究或收集常見的新手問題，並確保您的指南迴答它們。

如果許多初次用戶問“我如何節省進度？”然後在適當的位置主動將其包括在指南中。

與用戶知識水平相處是良好的入職的一部分。您既不與他們交談，也不會讓他們迷失在樹林中，從而尊重用戶。

6。保持鼓勵和人類

入門指南不是乾燥的規格表。隨意注入個性和鼓勵。

諸如“你們都設定的短語！”或“讓我們下一步做X”使用戶感到由一個人而不是機器人引導。

如果適合您的品牌，您甚至可以使用溫和的幽默或相關比​​較。例如，“創建發票就像填寫Facebook帖子一樣容易，只需輸入文本並點擊發送即可。”

一點興趣可以減輕用戶焦慮。

但是，不要過度使用它，也不要分散實際說明的注意力。專業但溫暖是一個很好的平衡。

7。強調要點（但不要壓倒）

如果某些步驟至關重要，則可以使用大膽的文本或註釋突出顯示它們。

例如：“重要：請確保寫下您的恢復代碼。如果忘記密碼，則需要它。”這表明用戶要額外關注。

您還可以使用斜體來偶爾重點或引入一個術語（例如定義的項目或廣告系列）。

另一種策略是使用標註框或彩色亮點以獲取技巧，警告或筆記。

例如，一個黃色的“提示：”框可以共享快捷方式或替代方法，而紅色的“配x：”框可能會警告常見錯誤（ “在更新過程中不要拔下設備。” ）。

但是，在快速啟動時將它們保持在最低水平 - 太多的側音會淹沒。

8。與真實用戶一起測試指南

有了草稿後，如果可能的話，請在真正的新用戶上嘗試一下。

這可能是一個可用性測試會議，或者只是為新員工或朋友提供指南，看看他們是否可以在沒有其他幫助的情況下成功地遵循它。

他們的反饋是黃金。他們可能會偶然發現您認為很明顯的步驟，這意味著您應該澄清這一步驟。或者他們可能會問：“這是什麼意思？”通過一定的指示，這意味著您可能需要重新命名或添加簡短的說明。

測試還將顯示您的指南流是否與用戶自然設置的方式匹配。

如果面對面測試不可行，即使僅觀察新客戶的支持請求也可以照亮差距。

例如，如果許多用戶與指南應該回答的問題聯繫，則該指南可能需要該信息更加突出。

使用此反饋來迭代並不斷改進指南。

諸如英雄知識基礎之類的文檔工具提供功能，使您可以收集用戶反饋並提供其他有用的見解。明智地使用這些工具來改善您的指南。

9。保持短暫而專注

值得重申的是 - 簡短是快速入門指南的關鍵。

當用戶渴望開始使用該產品時，通常不會閱讀中篇小說。

如果您的指南長期運行，例如，多幾頁或屏幕審核並問： “入門時確實需要此細節，還是可以將其移至文檔的後續部分？”

修剪不必要的脂肪。文檔專家的一個指南是我們提到的1/10規則：快速啟動僅包含大約10％的完整手冊信息。這不是一門精確的科學，但它加強了這樣的觀念，即這不是詳盡的細節的地方。

保持關注直接需求。如果您發現指南變得笨拙，因為您的產品具有大量功能，請考慮按用戶目標或角色分配指南。

例如，單獨的“管理員快速設置”與“最終用戶的快速啟動”，因此每個受眾都會獲得更精美的體驗。

在文檔中，就像在UI設計中一樣，更少的是入職。

通過遵循這些寫作技巧，您將製作一份不僅內容豐富的指南，而且引人入勝。

入門指南示例

讓我們看一些現實世界中開始指南和快速起步指南以查看這些原則的現實示例。

這些示例涵蓋了數字軟件入職和物理產品指南：

1。 UPWORK入門頁面

自由職業平台UpWork為新移民提供了出色的入門指南。

首先要祝賀用戶加入，然後列出了一些關鍵任務，以使其配置文件啟動並運行：完成清單，為新的自由職業者提供在線課程，設置其個人資料，等等。

該語言令人鼓舞，並且將步驟作為符號點提出，以便於掃描。 UPWORK還提供了指向更深層次的資源的鏈接，例如“ 9個技巧，可幫助您創建一個脫穎而出”。

本指南不會對每個站點功能不堪重負；它專注於新自由職業者在平台上獲得成功機會的關鍵事情。

通過這樣做，它可以推動用戶參與度（完全設置的自由職業者配置文件）並減少混亂。

2。谷歌文檔快速啟動指南

對於Google文檔，幫助文章“如何使用Google Docs”本質上是快速入門指南。

一個整潔的方面是它可以滿足不同的平台：它具有用於計算機， Android ， iPhone/iPad的選項卡或部分，並認識到啟動可能會因設備而略有不同。

該指南非常逐步。它首先要簡要說明Google文檔（在線文字處理器等），然後迅速進入“開始步驟”，例如創建新文檔，共享它，等等。

每個步驟通常都有插圖或圖標。 Google的指南還鏈接到技巧（例如，對於那些想學習更多高級技巧的人來說，“獲取使用Google Docs的最重要技巧”）。

該語言很簡單，並且沒有對Google Drive或Docs的先驗知識。通過將其分解為每個設備，它立即解決了用戶的上下文。移動用戶不會被桌面說明淹沒，反之亦然。

此示例顯示了識別用戶環境並相應地量身定制指南的重要性（這是了解受眾的一種形式）。

3. Slack的幫助中心房屋

流行的消息傳遞應用程序Slack通常因其出色的文檔和入職而受到稱讚。在Slack的Help Center首頁上，有一個明顯的“入門”類別與其他類別（例如使用Slack，您的個人資料等）一起使用。

Slack的此入門部分包括指導新用戶通過基礎知識的文章。

Slack的一位入門指南實際上可以直接跳入解釋界面- 因此新用戶可以熟悉術語和佈局。

Slack經常使用帶註釋的屏幕截圖和“這是您的頻道出現的位置”之類的標註，依此類推，從而非常容易將描述與實際應用程序連接起來。

Slack示例演示了入門部分如何定向用戶，然後用戶可以自我選擇他們需要什麼幫助。也許一個用戶想知道如何發送消息，另一個用戶想安裝桌面應用程序 - Slack的文檔為每個文檔提供了單獨的快速指南。

這種模塊化方法使每個指南都集中在同時覆蓋很多基礎的同時。

這些例子教給我們一些事情：

• 量身定制的受眾和環境： UPWork的指南是針對自由職業者，HubSpot的開發人員，Slack的辦公室工作人員以及設備所有者的小工具指南量身定制的。音調，詳細級別和格式都與用戶的上下文匹配。例如，開發人員獲得了更技術性的基調，普通用戶會獲得更多的視覺手工握力。
• 保持簡潔和以任務為重點：所有指南都專注於啟用前幾個任務，而不是一次解釋一切。他們充當發射台。
• 巧妙地使用視覺效果：從Slack的帶註釋的屏幕截圖到Google的平台圖標到硬件插圖，可以在可以替換或加強文本的任何地方使用視覺效果。
• 如果需要，提供多種格式：同時提供在線和PDF版本（Microsoft）或分開快速啟動與完整手冊（GOPRO）確保用戶可以選擇消耗信息的方式。 PDF快速啟動指南對於打印或離線訪問特別有用 - 如果您的用戶可以欣賞它，請考慮提供。
• 與更大的文檔集合集成：入門指南通常鏈接到或與更全面的資源鏈接。它們不孤立地存在。

快速啟動指南（PDF）與完整入門指南

您可能想知道“快速入門指南”和完整的“入門指南”之間的區別 - 它們不是一樣嗎？

這些術語有時會互換使用（實際上，它們是在目的上重疊的），但是內涵和範圍存在細微的差異。

讓我們澄清差異和相似性，尤其是與格式相關（例如PDF）和內容深度時：

最後的想法

撰寫《入門指南》似乎是很多工作，但這是您為產品的成功而進行的最有價值的投資之一。

這是一個好奇的新用戶和滿意，自信的客戶之間的橋樑。

正確完成後，您的指南將在背景中悄悄地執行奇蹟：

• 大規模入職用戶
• 減少支持門票
• 通過表明您從第一階段開始關心用戶體驗來建立商譽。

我在本指南中介紹了很多。總結一下，這是一個快速清單，可以在完成您的入門指南時考慮：

• 它有明確的開始，中間，結束嗎？ （概述→步驟→下一個/支持）
• 它盡可能短但不短嗎？ （剪裁絨毛，保留必要的指導）
• 說明是否明確和新手友好？ （如果可能的話進行測試）
• 您包括有用的視覺效果嗎？ （它們標記/放置好嗎？）
• 語氣友好和自信嗎？ （對話，不屈服或太簡短）
• 如果指南還不夠，您是否提供幫助的途徑？ （鏈接到文檔，支持）
• 它可以訪問且易於閱讀嗎？ （良好的格式，簡單的語言，高可讀性得分）
• 您是否將其集成到整體文檔或入職流中？ （用戶可以輕鬆找到它）

如果您可以檢查所有這些，那麼您的手上可能會有出色的入門指南。

現在，出去創建指南，歡迎您的用戶像英雄一樣。祝您好運，也許您的用戶永遠不會丟失！