如何使用視覺效果創建分步說明

已發表: 2017-02-21

有些教程需要的不僅僅是文本,讀者才能理解。 通過使用視覺效果創建分步說明,您可以讓讀者了解可能無法傳達的細節。 這些視覺效果可以是靜止圖像或屏幕截圖、動畫 GIF、比較圖表或視頻。 除了幫助讀者理解你的內容之外,視覺效果還打破了大量文本的單調。

去年,我一直在 Joyent 擔任技術作家,編寫說明並製作面向所有技能水平用戶的視頻。 這需要精確——人們依靠我為技術任務創建分步說明和指南。 如果我錯過了一步或假設讀者已經知道一條信息,他們可能會沮喪地走開,再也不會回到我們的內容。 另一方面,如果我詳細了,內容可能會感覺過多和漫無邊際,並且需要更頻繁的更新。 無壓力。

找到可以用圖像代替一些過於精確的細節的地方可以節省我的時間和精力。 另外,讀者離開時知道他們期待看到什麼,這有望讓他們的生活更輕鬆。 盡可能遵循一些關鍵的寫作建議:展示,不要告訴(非常重要,它有自己的維基百科頁面)。

您無需成為技術作家即可從精確的流程用語中受益。 繼續閱讀以了解準備說明並向任何文檔添加視覺效果的策略。

在開始可視化之前,請考慮您的受眾

在製作任何內容之前,您應該知道您為誰製作內容以及他們的期望是什麼。 雖然不可能預測每個讀者的個人需求,但您建立的規則會影響內容的基調,並且可以幫助您在創建流程大綱時做出決定。

觀眾

考慮以下:

  • 我的讀者已經是專家了嗎? 他們以前是否做過這個過程,如果不是完全在類似的情況下?
  • 我的讀者是內部的還是外部的? 如果我的讀者在同一家公司,我們分享什麼語言可以幫助更好地解釋這個過程?
  • 他們會以什麼心情滿足我的要求? 我是為急於完成某事的人創建此內容,還是為只是希望在某個主題上進一步學習的更隨意的學習者創建此內容?
  • 對我的讀者來說最重要的是什麼? 什麼是最不重要的?
  • 我的讀者喜歡如何學習? 我知道博客文章是否比視頻更成功嗎? 是否有任何分析數據支持這些說法?
  • 我的讀者是以英語為母語的嗎? 如果我使用成語,會不會妨礙他們學習如何完成流程?

無論你在創造什麼,你總是在另一端與讀者一起創造它。 您越了解您的讀者並為他們製作內容,他們就越有可能繼續回來獲取更多內容。

僅使用盡可能多的細節來概述流程

為任何媒體準備流程或教程的一種方法是從包含兩列的表格開始。 第一列將包含讀者完成任務所需的每個單獨步驟。 這些步驟可以像“提交申請”一樣小而精確,也可以像“完成表格的其餘部分”那樣大而不具體。

第二列將是您的視覺過程列。 起初,這可能根本不包括任何實際的視覺效果,而是對視覺效果的描述。 如果您正在創建書面文檔,則不需要為第一列中的每個步驟提供匹配的視覺效果。 如果您要創建截屏視頻,每個框都應該有關於要包含的視覺類型的註釋。 視頻中應該幾乎沒有空屏時間。

此表的示例在下面的“示例大綱”下,但首先您必須了解更多有關視覺輔助工具的類型。

視覺效果的類型以及何時使用它們

每個過程都可以從不同類型的視覺效果中受益。 媒介將根據其用途而改變。

  • 靜止圖像——這是嘗試將物理產品可視化的完美媒介,無論是人還是特定對象(如平底鍋)。 這些可以是庫存照片或您拍攝的照片。
  • 屏幕截圖——當談論在您的計算機上看到的產品(例如網站或其他軟件)時,屏幕的靜止圖像非常有用。 它們非常容易獲取和編輯,尤其要感謝 Snagit。
  • GIF – 動畫圖像非常適合解釋可能不太容易表達的簡短過程(不到 8 秒)。
  • 圖表– 條形圖、餅圖、折線圖等多種圖表! 在談論和比較一組數字時,圖表是最佳選擇。
  • 視頻——終極視覺效果,視頻非常適合解釋流程。 如何製作出色的技術視頻是一種藝術形式,當然可以通過這個過程得到幫助,但需要更多的計劃。 (幸運的是,我從 TechSmith 那裡學到了很多東西,他們對這個主題還有很多話要說)。

隨意在您的寫作中使用多種媒介。 每個都將滿足不同步驟的不同需求。

示例大綱

食譜是通常需要精確度的過程的最佳示例之一,視覺效果可以產生巨大的差異。 假設我想概述製作蛋糕的說明:

桌子 {

邊框折疊:折疊;

}

表,td,th {

邊框:1px 實心#404040;

填充:4px;

}

腳步視覺效果
1.收集所有成分以確保沒有遺漏。 如果缺少一種成分,請在繼續之前獲取該成分。 組裝好的食材圖片
2. 將烤箱預熱至 350 華氏度。
3. 在一個 9 x 9 英寸的方形蛋糕盤上塗上油脂並撒上麵粉。
4. 在一個中等大小的碗中,將糖和黃油攪勻。 奶油過程的GIF
5. 將雞蛋一個一個打入碗中,攪拌均勻。
6. 加入香草。
7. 將麵粉和泡打粉篩入碗中,攪拌均勻。 可能會留下麵粉團塊或條紋。 篩選的GIF或成品攪拌產品預乳的照片
8. 加入牛奶攪拌至麵糊完全光滑。 完成麵糊的照片(可能與步驟 7 的圖片並排)
9. 將麵糊倒入或舀入準備好的蛋糕盤中。
10. 放入預熱好的烤箱烤30-40分鐘,蛋糕表面金黃即可。 頂部應該彈回觸摸。 蛋糕成品照片

如果每一步都有一個圖像,那就有點……無端了。

選擇你的視覺效果

我選擇的圖像有助於在更大的流程中闡明小型流程。 特別是,到目前為止攪拌的第 7 步中的圖片是重要的視覺證據。 用這個指令烤了很多蛋糕,恰到好處和過度混合的區別……我希望我總是有一張照片。 可能會有一本說明手冊,上面寫著混合多長時間的複雜性——每隔一頁就必須是一張圖片。

在概述了您需要的視覺效果之後,您必須收集貨物。 對於此示例,最好為您烘烤蛋糕的過程拍照。 對於其他流程,您可能不需要拍攝自定義照片。 有各種免費和優質的圖庫攝影網站,其中包含視頻、GIF 和靜態照片,供您自行決定使用。

與您的目標受眾進行測試

在目標受眾中的某個人閱讀並獲得批准之前,沒有一篇文章是完整的。 他們的輸入將展示您在流程中錯過了哪些步驟或需要更多視覺效果的地方。

面試

解決此問題的最簡單方法(無需可用性團隊的大量資源)是請您的關鍵人群中的一些人閱讀您的內容,並嘗試完全按照所寫的流程進行操作。 雅各布尼爾森經常被引用說,五個人是捕捉最多問題的最佳人數。

無節制的測試

無節制的測試非常適合資源有限的小型項目——或者只是當您需要快速獲得結果時。 您可以使用許多工具來獲得更精確的結果,但如果您只是在尋找有關較小流程的反饋,您可能只需將文檔發送給您的測試人員並提出您想要的一組問題即可回答。

讓您的測試人員在有問題、查看可能遺漏的內容、在過程中遇到障礙或希望他們有更詳細的說明時做筆記。 希望他們能夠在給您反饋之前完成任務。

適度測試

適度測試的最大好處是,您實際上可以觀察您的測試人員執行該過程並查看他們在哪裡感到困惑,而不是依靠他們來為您注意到困惑。 如果您記錄會話,這樣您就不必完全依賴您在會話期間所做的筆記,那就更好了。

一路上問問題。 例如:

  • 您是否了解您被要求執行的任務? 這個任務有意義嗎?
  • 什麼會使這個過程更容易完成?
  • 如果有一個帶有步驟的視覺效果,視覺效果是否有助於您理解該做什麼?
  • 你希望有更多的視覺效果嗎?

包起來

您現在知道為什麼應該將視覺效果添加到分步說明中,並擁有大量工具來幫助您在視覺輔助工具的幫助下成功創建分步說明。 熟能生巧。 您在流程中添加圖像的第一次嘗試可能並不完美,但是通過一些用戶測試來指導您的編輯流程,您將幫助您的用戶了解如何完成任務。

您是否有另一種方法來確定何時在說明中添加視覺輔助工具? 在下面的評論中分享您的提示!

編者註:這篇文章最初發表於 2017 年 11 月,為了準確性和全面性已經過更新。