有些話說在前頭
因為公司產品業務重構且功能拆分組件化,往后會有很多的接口文檔需要留存,所以急需一款文檔管理系統。當時選型要求3點:
1.不能是雲平台上的Saas服務,整個系統都要在自己公司部署維護(數據安全)
2..NET平台開發(利於維護)
3.開源(可按需重構)
大約三周前,在線上找了很久開源的文檔管理系統但都不盡人意。(showDoc很好,但可惜不是.NET平台的,自個在公司大約有7個測試服務器資源(都是Windows Server),雖然有物理機權限可以自己隨意創建虛擬機資源,但是考慮未來維護最終舍棄了)
而團隊大量文檔需要整理留存,我個人也因低效的文檔留存方式而被另外一個開發妹子問的心態快炸(總會被打斷思路),痛定思痛,下定決心要開發一套文檔管理系統拯救我即將變白的黑發。
開發周期大約為4天既兩個周末,因為趕工所以並非所有的容錯細節都實現(比如:人員信息郵箱不可重復),但這只是個別,百分之九十都已做細節上的處理,並不會影響使用。
遺留問題后續的迭代將會完善。
關於QuarkDoc
QuarkDoc是一個極簡主義的文檔管理系統。適用於團隊或個人管理文檔,提升團隊溝通成本(本人未來的迭代路線也將以文檔管理及開發常用輔助功能為主)。
目前(beta)包含模塊:團隊人員管理,項目管理,目錄管理,文檔管理,輔助功能。
人員管理:權限為管理員和非管理員兩者,非管理員將無法使用團隊人員管理模塊。
項目管理:非管理人員不可使用此模塊。
目錄管理:目錄結構為3層可任意配置。
輔助功能:
1.Json數據格式驗證
2.JSON參數轉Url
3.Http模擬請求
版權相關
QuarkDoc遵循BSD許可協議(最大誠意了)。
即:你可以自由獲得、復制、修改、分發本原創軟件作品(源碼);也可在源碼基礎上衍生你的軟件作品。
衍生的軟件作品(其源碼)可以閉源而無需放置我的任何版權說明。但不可引用我的任何相關信息用於軟件的版權聲明或廣告促銷等。
注意:若使用QuarkDoc進行商業行為或衍生產品使用了本軟件前端HTML部分請購買前端HTML正規許可( https://www.creative-tim.com/product/material-dashboard-pro/?affiliate_id=101249)這個前端樣式框架不是我寫的的需要另外獲取許可。
更新日志
QuarkDoc的維護更新及源碼發布一定是在 http://www.cnblogs.com/jonins 其它任何平台(如:GitHub、開源中國、CSDN等)都非原作者。(密碼太多真心記不住,簡簡單單挺好)
/*****************************************************************************************************************
2018年9月4日 beta
鏈接:https://pan.baidu.com/s/15VUkMNyJjsY9ATsEIzUt5Q 密碼:fvps 解壓碼:cnblogs/jonins
QuarkDoc出生並開源
******************************************************************************************************************
迭代計划:
1.代碼刪減,封裝、並規范化(開發周期過短遺留下來的問題)。
2.圖片上傳。
3.附件上傳。
4.模板留存。
5.歷史版本。
6.權限(分項目、分讀寫)。
*****************************************************************************************************************/
部署QuarkDoc
1.下載源碼
2.發布Mins.QuarkDoc.Web
3.在SQL Server 2008及以上版本執行數據庫創建腳本(Mins.QuarkDoc.Web項目DBScript文件夾下DBScript.sql文件)
4.修改Web.config文件下的數據庫連接串
1 <connectionStrings> 2 <add name="DBContext" connectionString="Data Source=server;Initial Catalog=QuarkDoc;User ID=sa;password=password" providerName="System.Data.SqlClient" /> 3 </connectionStrings>
5.程序可以執行,初始登錄權限(后續可以在人員管理進行修改)
賬號:jonins@admin.com
密碼:admin@admin
重構QuarkDoc
若認為QuarkDoc不錯,想根據自己的需要更改需求,下面的內容或許能幫到你。
1.技術棧
前端:Vue + wangEditor + Bootstrap + Jquery.Validate + SweetAlert + Nouislider + Xss.js
后台:Asp.NET MVC + EntityFramework6 + Unity2.0 + Newtonsoft.Json + Nlog(本身是有的,DLL都拿過來了,但是在公司一周測試試用,並沒有出現過問題,所以日志記錄就暫時不加了)
設計思想:數據層采用倉儲模式,業務層通過依賴注入繼承基類的方式減少基礎方法的直接實現,可使開發者更關注業務本身。因為本系統業務並不復雜,項目的邏輯壓力根本沒有到達邏輯層,大部分在控制器就已完成。
2.源碼概括
示例QuarkDoc