日照網站建設公司告訴你什么是文檔中心

何為文檔

文檔是系統設計的藍圖。沒有文檔，我們將難免重復解決已經解決過的問題，而且花大量時間查看代碼來尋找簡單的答案。沒有文檔，我們的新員工只能對著系統抓耳撓腮，并懷疑在這種系統中怎么可能完成自己的任務。

回顧一下目前為止我們設計過的所有架構，如果不花同等的時間來講一下寫文檔的方法，那簡直是一種罪過。寫文檔是開發工作的一部分，而不是等重要工作完成后才開始的事情。就像需要重構的臃腫代碼、需要自動化的低效率流程，或者沒有被測試覆蓋到的函數一樣，略過文檔也會欠下技術債。

不要以為文檔只是簡單地寫下代碼如何工作。的確，我們需要在開發流程中預留出寫文檔的時間，用于記錄我們開發的代碼是如何工作的，但是寫文檔遠遠不止為每一行代碼寫一段描述。

文檔有多種形式，而其中很多只有在架構支持時才能成型。雖然有些文檔只是用于描述每個函數的普通文本，但這種文檔背后往往有一套基于搜索、導航和視覺呈現的構建系統。其他的文檔用于展示系統的資源，由我們所寫的樣式、腳本、模板和模式來驅動。

靜態文檔

Hologram是基于 Ruby 的通用文檔工具，你可以在代碼庫中寫小段的注釋，然后通過它來收集這些注釋生成的靜態頁面。這些 Markdown 格式的文檔塊可以放進你的 Sass、CSS 或者 JavaScript 文件中。這些文檔塊還包括用于描述頁面名稱和導航等相關信息的元數據，并且它的書寫形式完全自由。Hologram 讓你可以將文檔內聯地寫在代碼中，這有助于使文檔保持近時間建立，同時使開發人員總能看到這些文檔。

SassDoc是基于 Node 的系統文檔工具，它宣稱“SassDoc 對于 Sass 的意義，就像 JSDoc 對于 JavaScript 的意義一樣”，而且它的確如此！ SassDoc 與 Hologram 有點像，它也依賴于代碼中內聯的注釋來生成文檔。然而，Hologram 是通用的、多功能的工具，SaasDoc 卻專注于描述 Sass 變量、函數、混入（mixin），以及它們是如何相互影響和依賴的。如果你正在構建一個大型的 Sass 框架，或者一個復雜的柵格或顏色系統，SassDoc 正是你想要的工具。

代碼驅動的文檔

Pattern Lab 是多平臺模式庫工具，它使你可以模塊化地開發設計系統，并將模板和 CSS 轉換成可瀏覽的模式庫。在模塊化的系統中，你可以先開發每個單獨的模式片段，然后通過組合這些片段產生更復雜的模式。Pattern Lab 提供了一個基本框架，用于模塊化地創建并組合這些片段，使之成為更復雜的模式，甚至還能輸出完整的頁面?？深A覽的組件庫是開發者、設計師、用戶體驗師、質量工程師和產品所有者聚在一起時可以使用的很好工具。它為設計系統中的每個部分創建了一門通用的語言和穩定的參照系。

JSON 模式是用于描述數據格式的語言，同時也可以說明數據的驗證方式。在前端架構的領域中，可以用 JSON 模式來描述模板和模式所需要的數據。JSON 超模式甚至可以描述能夠通過 HTTP 協議與設計系統交互的方法，包括驗證、渲染和測試。JSON 模式是一種代碼驅動的文檔工具，因為它提供了驗證和驅動編輯工具的功能。JSON 模式還提供了可讀性很強的系統手冊，取代了開發者實現一個功能所需的一大堆手寫說明。

以上是日照網站建設公司（昊諾網絡公司）分享，如果你想了解更多的網站建設知識請關注我們網站的動態！