
滴滴企業(yè)版API文檔
最近在工作中看到合作方的API文檔,不禁思考,工程師這種用Gitbook管理文檔的方式,是否也適用于設(shè)計師呢?畢竟它的優(yōu)點很多:
1.即時更新:基于Gitbook生成的html文件,可以隨時發(fā)布到線上,這樣每次改動后,文檔的讀者訪問原來的連接就可以看到最新文檔,可以保證相關(guān)讀者看到的文檔就是你發(fā)布的最新文檔,在快節(jié)奏的產(chǎn)品研發(fā)流程中,可以避免許多溝通成本。
2.輕松的版本管理:使用Git的一大好處就是想回到哪里就回到哪里,把Gitbook作為文檔管理工具,就再也不怕改回前稿了。
3.布局清晰簡潔:左側(cè)帶有分層級的目錄導航,相比于常規(guī)的Pdf文檔,讀者能更清晰的了解文檔的結(jié)構(gòu)和自己所處的位置,閱讀體驗更好。
4.內(nèi)容自適應:相比于Axture生成的html文件,Gitbook內(nèi)容可以實現(xiàn)自適應,不需要頻繁拖動、縮放即可查看。
5.有查找功能:討論問題時可以精確定位。
6.樣式美觀:在Gitbook中不需要樣式調(diào)整就可以自動生成美觀的html文件,這對追求產(chǎn)出物觀感品質(zhì)的設(shè)計師來講,實在是成本低又有實效的絕佳工具。
7.團隊協(xié)作(付費):在Gitbook中,團隊中的幾個人可以共同維護一個文檔,對一個文檔的不同部分提出問題等,這也是它的一個巨大優(yōu)勢。
經(jīng)過小半天的研究,終于搞定了使用Gitbook客戶端配合三行代碼生成html文件的方法,基本上解決了落實障礙,后期準備在工作中小范圍使用,觀察效果,有心得再發(fā)文。