建站
咨詢
售后
建站咨詢
新聞中心
Wizard 是一款開源文檔管理系統(tǒng)，項目地址為 https://github.com/mylxsw/wizard。這個項目是 我 在2017年就開始開發(fā)的，起初只是想做一款能夠在公司內(nèi)部把Swagger文檔管理起來的工具，但在這近兩年的時間里，一直斷斷續(xù)續(xù)的為其添加各種功能，現(xiàn)在終于下決心發(fā)布1.0版本了，目前支持三種類型的文檔管理
Markdown：也是Wizard最主要的文檔類型，研發(fā)團隊日常工作中交流所采用的最常用文檔類型，在 Wizard 中，對 Editor.md 項目進行了功能擴展，增加了文檔模板，Json 轉(zhuǎn)表格，圖片粘貼上傳等功能
Swagger：支持 OpenAPI 3.0 規(guī)范，嵌入了 Swagger 官方的編輯器，通過定制開發(fā)，使其融入到 Wizard 項目當中，支持文檔模板，全屏編輯，文檔自動同步功能
Table：這種文檔類型是類似于 Excel 電子表格，采用了 x-spreadsheet 項目，將該項目嵌入到了 Wizard 中，目前還不是很完善
目前主要包含以下功能
- Swagger，Markdown，Table 類型的文檔管理
- 文檔修改歷史管理
- 文檔修改差異對比
- 用戶權(quán)限管理
- 項目分組管理
- LDAP 統(tǒng)一身份認證
- 文檔搜索，標簽搜索
- 閱讀模式
- 文檔評論
- 消息通知
- 文檔分享
- 統(tǒng)計功能
如果想快速體驗一下Wizard的功能，有兩種方式
- 在線體驗請訪問 http://wizard.aicode.cc/ ，目前只提供部分功能的體驗，功能預(yù)覽和使用說明請參考 Wiki。
使用Docker來創(chuàng)建一個完整的Wizard服務(wù)
進入項目的根目錄，執(zhí)行
docker-compose up，就可以快速創(chuàng)建一個Wizard服務(wù)了，訪問地址 http://localhost:8080 。
起源
為了鼓勵大家寫開發(fā)文檔，最開始我們選擇了 ShowDoc 項目來作為文檔管理工具，當時團隊規(guī)模也非常的小，大家都是直接用 Markdown 寫一些簡單的開發(fā)文檔。后來隨著團隊的壯大，前后端分離，團隊分工的細化，僅僅采用 Markdown 開始變得捉襟見肘，這時候，我們首先想到了使用開源界比較流行的 Swagger 來創(chuàng)建開發(fā)文檔。但是 Swagger 文檔多了，總得有個地方維護起來吧？
項目中的文檔僅僅用Swagger也是不夠的，它只適應(yīng)于API文檔的管理，還有很多其它文檔，比如設(shè)計文檔，流程圖，架構(gòu)文檔，技術(shù)方案，數(shù)據(jù)庫變更等各種文檔需要一起維護起來。因此，我決定利用業(yè)余時間開發(fā)一款 支持 Markdown 和 Swagger 的文檔管理工具，也就是 Wizard 項目了。
起初打算用 Go 語言來開發(fā)，但是沒過幾天發(fā)現(xiàn)使用 Golang 來做 Web 項目開發(fā)效率太低（快速開發(fā)效率，并非指性能，Golang做API接口開發(fā)還是很不錯的），很多常用的功能都需要自己去實現(xiàn)，遂放棄使用 Golang，轉(zhuǎn)而使用 PHP 的 Laravel 框架來開發(fā)。所以雖然項目創(chuàng)建的時間為 2017年7月27日，但是實際上真正開始的時間應(yīng)該算是 2017年7月31日。
起初Wizard項目的想法比較簡單，只是用來將 Markdown 文檔和 Swagger 文檔放在一起，提供一個簡單的管理界面就足夠了，但是隨著在團隊中展開使用后，發(fā)現(xiàn)在企業(yè)中作為一款文檔管理工具來說，只提供簡單的文檔管理功能是不夠的，比如說權(quán)限控制，文檔修改歷史，文檔搜索，文檔分類等功能需求不斷的被提出來，因此也促成了 Wizard 項目的功能越來越完善。
- 用戶權(quán)限管理 參考了 Gitlab 的權(quán)限管理方式，在用戶的身份上只區(qū)分了 管理員 和 普通用戶，通過創(chuàng)建用戶組來對用戶的權(quán)限進行細致的管理，同時每個項目都支持單獨的為用戶賦予讀寫權(quán)限。
- 項目分組 在 Wizard 中，文檔是以項目為單位進行組織的，剛開始的時候發(fā)現(xiàn)這樣是OK的，后來項目越來越多，項目分組功能應(yīng)運而生，以目錄的形式來組織項目結(jié)構(gòu)。
- 文檔修改歷史 每次對文檔的修改，Wizard 都會記錄一個快照，避免錯誤的修改了文檔而造成損失，可以通過文檔歷史快速的恢復文檔，對文檔的修改，新增，刪除等關(guān)鍵操作都會記錄審計日志，以最近活動的形式展示出來。
- 文檔差異對比 在團隊協(xié)助中，經(jīng)常會出現(xiàn)很多人修改同一份文檔，為了避免沖突，文檔修改后，其它人在提交舊的歷史版本時，系統(tǒng)會提示用戶文檔內(nèi)容發(fā)生了變更，用戶可以通過文檔比對功能找出文檔中有哪些內(nèi)容發(fā)生了修改。
- 閱讀模式 當使用投影儀展示文檔來過技術(shù)方案的時候，為了減少不必要的干擾，使用閱讀模式，只展示文檔內(nèi)容部分，提供更好的展示體驗。
- 文檔搜索 通過搜索功能快速查找需要的文檔，目前支持通過文檔標題來搜素文檔，后續(xù)會增加全文檢索功能。
- LDAP支持 很多公司都會使用 LDAP 來統(tǒng)一的管理公司員工的賬號，員工的在公司內(nèi)部的所有系統(tǒng)中都是用同一套帳號來登錄各種系統(tǒng)比如 Jira，Wiki，Gitlab 等，Wizard 也提供了對 LDAP 的支持，只需要簡單的幾個配置，就可以快速的接入公司的統(tǒng)一帳號體系。
- 文檔附件，文檔分享，統(tǒng)計，文檔排序，模板管理，文檔評論 ...
關(guān)于代碼
項目采用了 Laravel 框架開發(fā)，目前版本已經(jīng)升級到最新的 5.8（最開始為5.4，一路升級過來）。為了提高開發(fā)效率，保持架構(gòu)的簡潔，在開發(fā)過程中，一直避免引入過多的外部組件，盡可能的利用 Laravel 提供的各種組件，比如 Authentication，Authorization，Events，Mail，Notifications 等，非常適合用來學習 Laravel 框架。
總結(jié)
如果你在為公司尋找一款開源免費的 開發(fā)文檔/API文檔管理 工具，不妨考慮一下 Wizard 項目，一定不會讓你失望的。如果你是一名 PHP 或者 Laravel 新手，想找個項目學習一下如何用 Laravel 做 Web 開發(fā)，這個項目更加不能錯過！
最后，也是本文最核心的部分，趕緊去 Star 一下，順便給我個 Star 啊 ！如果再能貢獻點 Issues 或者P R，那就更好啦
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)cdcxhl.cn，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機、免備案服務(wù)器”等云主機租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價比高”等特點與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
網(wǎng)頁標題：Wizard開源文檔管理系統(tǒng)1.0發(fā)布啦-創(chuàng)新互聯(lián)
網(wǎng)頁網(wǎng)址：http://www.dlmjj.cn/article/pjgei.html
