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

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

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

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

本次給大家推薦一個(gè)在線 API 文檔的開(kāi)源工具：ShowDoc

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

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

▍ShowDoc介紹

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

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

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

▍ShowDoc可以用來(lái)做什么？

01 API文檔

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

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

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

03 說(shuō)明文檔

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

https://www.showdoc.cc/

▍ShowDoc都有哪些功能？

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

01 分享與導(dǎo)出

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

02 權(quán)限管理

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

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

• 項(xiàng)目成員

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

03 編輯功能

• markdown編輯

• 模板插入

• 歷史版本

04?多平臺(tái)

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

https://www.showdoc.cc/clients

▍使用在線的ShowDoc

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

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

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

• ShowDoc部署手冊(cè)請(qǐng)參考：

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

• 開(kāi)源地址：

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

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

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

——??e n d?———— 由于微信平臺(tái)算法改版，公號(hào)內(nèi)容將不再以時(shí)間排序展示，如果大家想第一時(shí)間看到我們的推送，強(qiáng)烈建議星標(biāo)我們和給我們多點(diǎn)點(diǎn)【在看】。星標(biāo)具體步驟為： （1）點(diǎn)擊頁(yè)面最上方“小詹學(xué)Python”，進(jìn)入公眾號(hào)主頁(yè)。 （2）點(diǎn)擊右上角的小點(diǎn)點(diǎn)，在彈出頁(yè)面點(diǎn)擊“設(shè)為星標(biāo)”，就可以啦。 感謝支持，比心。

總結(jié)

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

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