如何使用 WordPress 構建幫助創作工具
已發表: 2022-04-28優秀的技術作家永遠不會遠離他們值得信賴的幫助創作工具 (HAT)。
技術寫作行業的主力 - 一種幫助創作工具，可以承受壓力並改變“使復雜的事情變得簡單”的藝術......嗯，小菜一碟。
HAT 是技術作家的生產力最大化工具。 10x 技術作家牢牢把握住了他們遊戲的這一面。
經過這麼多階段的反复塑造和編輯副本，使其完美契合目的……
…您確實需要一個可以與您一起工作並幫助您將所有精力集中在製定最佳文學產品上的 HAT。
HAT 的概念並不新鮮。
他們一直在身邊。
有些人可能會說，如果它們是一張全家福，它們可能會變得有點捲曲、棕褐色，甚至失去相關性。
例如，在許多情況下，擁有 WYSIWYG 編輯器被認為是一項高級功能。
但是從更側面思考，是否有應用內容管理系統 (CMS) 的多功能性和多方面可轉移優勢來將 HAT 推入 21 世紀的案例？
我們認為，就 WordPress CMS 而言——世界領先的網絡構建平台和最受歡迎的 CMS 軟件……
……答案是：是的。
但是不要只相信我們的話，為什麼不花接下來的幾分鐘來更深入地研究一下為什麼 WordPress CMS 是自切片麵包濃縮咖啡以來技術作家的下一個最佳選擇。
這是使用 WordPress 構建幫助創作工具的 HeroThemes 指南。
當今技術作家的典型需求
今天的技術寫作涵蓋了許多專業科目。
- 政府公共政策
- IT計算
- 金融投資
- 房地產
……名單還在繼續。
但是，作為技術領域複雜的翻譯人員的嚴格要求是日常任務。
根據英國政府數字服務部的技術作家、服務設計和保證部的 Khidr Suleman 的說法，他的日常職責如下：
- 參與用戶研究
- 創建內容策略
- 向高級利益相關者提出計劃
- 設計和原型化用戶旅程
- 討論、編輯和（當然）寫作內容
相當多樣化。
然而，最後但並非最不重要的是（當然）在做他們真正做的事情。
但是寫作（尤其是技術寫作）是一個過程，而不是一種活動。
一場職責接力賽，共同導致文件交付。
簡而言之，技術寫作可以描述為“……捕獲、組織和維護有關快速變化的軟件系統的知識”的過程——Atom Bank
因此，技術作家生活中的一個共同特徵是處理存儲庫和知識庫。
例如，記錄引文或專家評論的片段。 以及以事實或數據的形式檢索金塊以驗證論點。
簡而言之，數據存儲、搜索和定位或發現的便利性——除了寫作——也是幫助創作工具的重要相關功能。
2022 年的幫助創作工具是什麼？
如果要相信幫助創作工具的第 1 頁 Google 定義的大部分內容，則準確的描述應包括：
- 製造
- 管理
- 出版
…文件。
大多數人聲稱更好的身份是“內容管理系統”。
誠然，該術語往往包含在 CMS 供應商撰寫的文章中（在這方面，本文不會有任何不同），但如果我們檢查使用的準確性 - CMS 畢竟是 HAT 的合適標籤。
它從字面上幫助技術作家編寫幫助文檔。
至於準確指出我們所說的幫助是什麼意思——我想對於你可以接受的範圍沒有硬性規定。
這真的取決於：
- 軟件製造商對技術寫作學科的了解程度，以及；
- 他們是如何說服他們滿足需求的
在大多數情況下，HAT 專注於使起草和編輯基礎正確。
並在頂部提供一些模板、樣式和編碼。
但問題是……
…僅這些功能就足以滿足現代技術作家的苛刻要求嗎？
我們為什麼不問幾個？...
- 在此反饋摘錄中，受訪者（技術作家）對傳統 HAT 功能與傳統 CMS（Drupal）進行了比較評論：
“作為 Drupal 的管理員，您可以查看頁面列表，但一次只能編輯一個頁面的屬性。 沒有多选和拖放。 所以主題管理可能非常費力。”
“如果你刪除一個頁面，那麼指向它的所有鏈接都會中斷，並且沒有任何消息可以警告你。
在頁面中創建鏈接時，您必須知道目標頁面的路徑和名稱——沒有可用頁面的有用列表。”
“開箱即用沒有所見即所得的編輯器。 對於大多數 HAT 用戶來說，這是必須的。 你只能用完整/過濾的 html 編寫你的內容。”
（來源：櫻桃葉）
- 在這篇評論中，另一位職業技術作家討論了他認為 HAT 軟件未來趨勢的兩個理想功能：
“Facted search：當用戶單擊搜索選項卡並蒐索項目時，用戶可以使用相似的構面來縮小搜索結果，如下圖所示。”
“使用任何標準的創作工具——Flare、RoboHelp、Author-It、Doc-to-Help——都會給你留下一個荒謬的模型，即一個作者從一個單一的有利位置從一個單一的組織試圖將一個海洋信息。 由於該模型站不住腳且不可擴展， HAT 將逐漸被基於 Web 的協作創作技術所取代。”
（來源：我寧願寫博客）
上面給出的見解擴展了傳統意義上的 HAT 的範圍，包括一個更加動態和協作的平台，以提高技術寫作效率。
您是否應該考慮使用組件內容管理系統 (CCMS) 進行幫助創作？
粒度贈品控制。
在技術寫作領域，在生產週期內更好地控制的優勢可以提高效率，從而轉化為更大的項目投資回報率。
這正是組件內容管理系統的用武之地。
什麼是組件內容管理系統 (CCMS)？
組件內容管理系統是一個 CMS，其內容項不是頁面和帖子，而是片段、段落和內容部分。
與您在 CMS 中製作新內容的方式相同，您將開始一個新頁面或發布一個新頁面。
使用 CCMS，您將啟動一個新組件（頁面或帖子的一部分）。
許多部分構成一個完整的頁面，因此整個頁面和帖子的最終結果是相同的，但是它們的製作方式被分成小塊。
為什麼？
規模經濟。
當然，基於多個部分（每個部分都有自己的元數據、依賴項等）而不是一個自由流動的整個部分來構建頁面可以說是更多的工作。
但是，對於具有大量主題交叉和內部引用的大規模複雜內容項目，組件級別的可重用性和粒度可互換性......
…CCMS 為寫作團隊提供了巨大的長期優勢。
即，更快、更準確地完成工作。
推薦的幫助創作工具建議文章
選擇最適合的幫助創作工具不僅僅是“功能和優勢”比較。
為了獲得最佳結果，您必須深入研究可用性。 了解工作流程和任務管理將幫助您了解每種解決方案的優缺點。
為了幫助您就該主題獲得一些同行推薦的諮詢，我們匯總了這個有用的 HAT 相關文章的快速列表：
- 為什麼 HAT 會褪色
- 我推薦使用基於雲的創作工具的 5 個理由
- 與 Drupal 相比，HAT 為您提供了什麼？
- 使用 HAT 軟件的 6 個理由
- 技術作家使用的 5 種創作工具
上述文章的作者對 HAT 的主題相當了解，並給出了一些關於做出正確決定的內部跟踪技巧。
HAT的主要特點是什麼？
因此，我們逐漸堅定了我們對 HAT 的看法、它們的作用以及我們應該考慮的除了傳統方法之外的外部優勢。
但是對於 HAT deos 的所有內容，我們仍然值得全面參考。
通過這種方式，我們可以在考慮投資選擇時比較“蘋果換蘋果”。
以下是最常見、最具包容性的 HAT 軟件功能列表：
- 多種輸入和輸出格式：使用多種文件類型導入和導出數據
- 功能齊全的文字處理器：基於代碼和可視化所見即所得編輯器
- 構建標籤：分配主題標籤以按主題關聯文章
- 主題模板：使用預製模板在每件作品上搶占先機
- Syntax highlighter : 有助於解決語法問題的亮點
- 合併項目範圍元信息的標籤：使用合併標籤輕鬆插入可重複使用的片段，節省時間並限制錯誤
- 自定義 HTML、CSS、Javascript：使用自定義 Web 代碼對功能和設計應用定制的觸摸
- 合併項目內容：合併同一項目中的內容以產生混合結果。
- 可定制的網頁主題：用於完善工具前端的開關、幻燈片和復選框，以改善您的用戶體驗
- 媒體存儲庫：所有圖像、PDF、音頻和視頻文件的整潔存儲區域
- 簡單的用戶界面：易於使用，所有相關控件都易於到達距離和定位
- 翻譯：多語言交付
- 目錄：易於使用的每篇文章中的跳轉鏈接，用於瀏覽內容
在專用的 HAT 中——以上幾點涵蓋了引擎蓋下預期的大部分內容。
構建自定義 HAT 的好處
如果我必須總結構建自定義 HAT 的主要好處，我會說：
掌握自己的工具集。
量身定制的工具集
當您擁有“您想要的”、“您想要的位置和方式”作為專業人士時，在節省時間和改善結果方面的投資回報是不可估量的。
您根本無法將使用“恰到好處”的工具與一組通用的“湊合”工具的體驗進行比較。
因此，定制自己的 HAT 可能需要大量的前期工作和大驚小怪。
但從長遠來看，場景是為您在每個項目中擊敗您的個人最好成績而設置的。
可擴展
等待路線圖的改進，或被擠進高級升級不需要使用自定義 HAT。
當然，您將自己負責維修和改進工具，但只需一點 DIY 時間，您就可以適當地延長 HAT 的保質期。
簡而言之，隨著您的 HAT 越來越好，您的結果也會越來越好。
更全面的表現
定制的 HAT 將從您的技術寫作工作流程中消除所有瑣碎或阻礙的煩惱。
您消除了所有瓶頸和時間消耗，取而代之的是功能、選項和配置，讓您在完成項目的競賽中順風順水。
您將輕鬆實現您認為以前可能的東西。
使用 Heroic Knowledge Base 插件製作 WordPress 幫助創作工具
所以，到現在為止，如果您準備好勇闖新領域並投入製作自己的 HAT，我們將為您提供合適的解決方案。
便於使用。
建立在超過 40% 的在線網站使用的平台上。
具有所有最佳功能 - 以及更多功能。
這是……我們關於誰使用 WordPress 製作 HAT 的快速指南。
最好的部分是根本不涉及任何代碼。 這種方法對初學者非常友好。
這是排隊：
- 頁面和文件的組織和分類
- 搜索、投票、反饋和分析
- FAQ組件複製
- 處理票務查詢的服務台
- 目錄頁面索引
- 術語庫
關於“為什麼使用 WordPress”的簡短說明。
對於大多數專業人士來說，擁有最適合工作的工具（不管它叫什麼）是最重要的事情。
當您沉浸在可交付成果中並且需要具有一定扭矩的引擎來挖掘您時，語義或名稱調用並不重要。
這是 WordPress 作為製作自定義 HAT 的理想平台。
首先，它勾選了本文前面提到的功能係列中的所有基本框。 它的核心產品開箱即用，輕鬆做到這一點。
WYSIWYG 和 HTML、CSS 和 JS 編碼等功能是 WordPress（世界領先的內容管理系統）提供的標準功能。
但 WordPress 還擁有 500 億美元的託管、插件和主題經濟。
這些參與者負責提供一流的擴展和性能幫助，使該工具成為適合目的的定制工具。
總而言之，WordPress 及其插件夥伴為任何想要 DIY 自己設置的技術作家提供 HAT 的夢之隊。
以下是我們推薦的使用 WordPress 構建您自己的在線市場的步驟的概述：
具有孤立類別的目錄主頁：一個中心頁面，用作已完成項目和研究資源的參考圖書館索引。 一個整潔的包羅萬象的位置，用於訪問您的技術寫作日誌。
使用 Heroic Knowledge Base 插件生成您之前發布的 HAT 內容的自動鏈接和逐項排列。
搜索、投票、反饋和分析：注意到我們在文章前面的貢獻技術作者的合作呼籲，我們在我們的 WordPress HAT 解決方案的功能中集成了活力和參與。 提供搜索、反饋和見解只會幫助開發更大的改進。
使用 Heroic Knowledge Base 插件來啟用用戶研究增強功能，以指導產品的迭代改進路線圖。
FAQ 組件複製：針對常見問題配置細粒度組件控制，讓您擁有更精簡的生產以擴展大型項目的優勢。
使用 Heroic FAQs 插件，通過簡單的安裝和血清代碼，通過內置的可重用組件來裝備你的 HAT。
通過工單處理查詢的英雄收件箱：方便地提供用戶支持工單，為您提供位於 WordPress 安裝內的響應式電子郵件幫助通道。
使用 Heroic Inbox 插件將您的企業電子郵件收件箱集成到您的 WordPress 管理儀表板中。 這為您在 HAT 中提供了一個統一的通信中心，從而節省了您花費在導航脫節工作流上的時間。
Heroic Table of Contents：跳轉鏈接，方便您的文章瀏覽，幫助讀者消化信息並提取價值。 使用經典的 ToC 讓您的作品更加易於使用。
使用 Heroic Table of Contents 為您的每篇文章添加一個自動填充的目錄。
Heroic Glossary：編譯一個 AZ 有用術語列表，作為訪問項目關鍵詞定義的快捷方式，讓您在編寫新項目時保持敏捷。
使用 Heroic Glossary 插件將可搜索的詞彙表安裝到您的 WordPress HAT 中 – 無需汗水，並且（再次）無需代碼。
Aspose.Words：立即將 WordPress 帖子或頁面轉換為 DOC 或 DOCX 文件，反之亦然。 彌合工作流程差距，使您的新系統與舊版 GDocs 或 Word 文檔資產兼容。
使用 Aspose.Words 插件啟用 WordPress 和 GDocs 或 Word 之間的雙向文件轉換。
Syntax Highlighter Evolved：在您進行自定義編輯時讓 Web 代碼脫穎而出，幫助您專注於細節而不會分心。
使用Syntax Highlighter Evolved使代碼在您進行精通網絡的編輯時變得美觀。
結論
在這些先進的 CMS 時代，特製的 HAT 可能正在重新發明輪子。
實際上，即使是功能最先進的 HAT 也沒有多少（如果有的話）可以做到具有某些配置的 CMS 無法做到的事情。
此外，使用 CMS，您還擁有額外的功能，可以為已經具有競爭力的產品增加優勢。
CMS（市場領先的 WordPress 及其插件）提供的進一步潛力可以擴展同類 HAT 解決方案，超出您的預期。
有足夠的空間來撓痒癢並繼續使用 WordPress 進行創新——而且無需編碼。
快速擴展的 3rd 方插件生態系統支持 WordPress 的市場份額優勢，其專業產品推動了可能性的邊界。
總而言之，我們相信，如果您希望進行面向未來的定制 HAT 投資，WordPress CMS 是理想的數字平台。
為什麼不從今天開始？