搞開發(fā)的同學(xué)都知道一個好的 API 文檔是有多重要！

每當(dāng)接手一個別人開發(fā)好的項(xiàng)目，看著那些沒有注釋的代碼，真的頭大。

程序員都很希望別人能寫技術(shù)文檔，因?yàn)榭梢蕴岣咦约洪_發(fā)的效率，而往往自己卻很不希望要寫文檔。畢竟寫文檔要花大量的時間去弄格式和排版，很多瑣碎的事情并不是程序員關(guān)心的。

而如果一直以word文檔傳來傳去，或者靠吼，一是顯得不專業(yè)，二是不利于團(tuán)隊(duì)長期高效工作。

本次給大家推薦一個在線 API 文檔的開源工具：ShowDoc

目前該開源項(xiàng)目已經(jīng)星標(biāo)7.5k了，作者是?star7th。

鏈接：https://github.com/star7th/showdoc

▍ShowDoc介紹

相信很多朋友也知道這個開源項(xiàng)目，因?yàn)檫@個開源團(tuán)隊(duì)宣稱已經(jīng)有超過1萬多個互聯(lián)網(wǎng)團(tuán)隊(duì)在使用它了。

當(dāng)然了，一般大公司肯定都有比較成體系的內(nèi)部工具，所以這個項(xiàng)目對于小公司開發(fā)團(tuán)隊(duì)來說無疑是一個寶藏。

ShowDoc就是一個非常適合IT團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率。

▍ShowDoc可以用來做什么？

01 API文檔

隨著移動互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。下面是一個用戶注冊的demo。

02 數(shù)據(jù)字典

一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個字段的釋義等。

03 說明文檔

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊(duì)查閱。showdoc的幫助文檔就是一個很好的示例，而且全部是中文。

https://www.showdoc.cc/

▍ShowDoc都有哪些功能？

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊(duì)

01 分享與導(dǎo)出

響應(yīng)式網(wǎng)頁設(shè)計(jì)，可將項(xiàng)目文檔分享到電腦或移動設(shè)備查看。同時也可以將項(xiàng)目導(dǎo)出成word文件，以便離線瀏覽。

02 權(quán)限管理

• 公開項(xiàng)目與私密項(xiàng)目

• 項(xiàng)目轉(zhuǎn)讓

• 項(xiàng)目成員

• 團(tuán)隊(duì)管理

03 編輯功能

• markdown編輯

• 模板插入

• 歷史版本

04?多平臺

showdoc支持網(wǎng)頁版、手機(jī)app版和電腦客戶端版。客戶端地址可見：

https://www.showdoc.cc/clients

▍使用在線的ShowDoc

• 如果你沒有自己的服務(wù)器，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc?http://www.showdoc.cc

• 在線showdoc作為在線服務(wù)會長期維護(hù)，請放心托管數(shù)據(jù)

▍部署到自己的服務(wù)器

• ShowDoc部署手冊請參考：

  https://www.showdoc.cc/help?page_id=13732

• 開源地址：

  https://github.com/star7th/showdoc?

• 二次開發(fā)指引：

  https://www.showdoc.cc/help?page_id=1385576954326448

- end -往期精彩回顧適合初學(xué)者入門人工智能的路線及資料下載機(jī)器學(xué)習(xí)及深度學(xué)習(xí)筆記等資料打印機(jī)器學(xué)習(xí)在線手冊深度學(xué)習(xí)筆記專輯《統(tǒng)計(jì)學(xué)習(xí)方法》的代碼復(fù)現(xiàn)專輯 AI基礎(chǔ)下載機(jī)器學(xué)習(xí)的數(shù)學(xué)基礎(chǔ)專輯獲取一折本站知識星球優(yōu)惠券，復(fù)制鏈接直接打開：https://t.zsxq.com/yFQV7am本站qq群1003271085。加入微信群請掃碼進(jìn)群：

總結(jié)

以上是生活随笔為你收集整理的【资源推荐】良心之作！超过 10000+ 的互联网团队正在使用的在线 API 文档、技术文档工具...的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。