最近要做一個sdk得api文檔，不知道怎么搞，文檔有快速入門，教程，還有具體得API文檔，加起來有500篇以上的內容，不可能一個個手寫吧。請問有沒有人知道類似一些框架和庫是怎么生成管理的，比如VUE，react這些官方文檔是怎么做的，有沒有具體的框架或庫，還請?zhí)峁﹤€大致的思路。自己研究了半天沒研究明白。
api的文檔一般是寫在代碼注釋中的,按照規(guī)定的格式寫,然后通過相應的工具轉換成文檔.
其他教程之類,就要自己寫了.當然,這些可以找現(xiàn)成的進行修改,沒必要完全從頭寫,至少結構上不用自己重寫
gitbook 了解一下。
js庫的文檔一般都是自己寫的，很少有使用注釋自動生成。
java后端的文檔一般都是通過注釋或者log自動生成。
Sphinx可以自動獲取代碼中的docstring注釋，自動生成文檔
文檔內容肯定是手寫的
北大青鳥APTECH成立于1999年。依托北京大學優(yōu)質雄厚的教育資源和背景，秉承“教育改變生活”的發(fā)展理念，致力于培養(yǎng)中國IT技能型緊缺人才，是大數(shù)據(jù)專業(yè)的國家
北大青鳥中博軟件學院創(chuàng)立于2003年，作為華東區(qū)著名互聯(lián)網(wǎng)學院和江蘇省首批服務外包人才培訓基地，中博成功培育了近30000名軟件工程師走向高薪崗位，合作企業(yè)超4
中公教育集團創(chuàng)建于1999年，經(jīng)過二十年潛心發(fā)展，已由一家北大畢業(yè)生自主創(chuàng)業(yè)的信息技術與教育服務機構，發(fā)展為教育服務業(yè)的綜合性企業(yè)集團，成為集合面授教學培訓、網(wǎng)
達內教育集團成立于2002年，是一家由留學海歸創(chuàng)辦的高端職業(yè)教育培訓機構，是中國一站式人才培養(yǎng)平臺、一站式人才輸送平臺。2014年4月3日在美國成功上市，融資1
曾工作于聯(lián)想擔任系統(tǒng)開發(fā)工程師，曾在博彥科技股份有限公司擔任項目經(jīng)理從事移動互聯(lián)網(wǎng)管理及研發(fā)工作，曾創(chuàng)辦藍懿科技有限責任公司從事總經(jīng)理職務負責iOS教學及管理工作。
浪潮集團項目經(jīng)理。精通Java與.NET 技術， 熟練的跨平臺面向對象開發(fā)經(jīng)驗，技術功底深厚。 授課風格 授課風格清新自然、條理清晰、主次分明、重點難點突出、引人入勝。
精通HTML5和CSS3；Javascript及主流js庫，具有快速界面開發(fā)的能力，對瀏覽器兼容性、前端性能優(yōu)化等有深入理解。精通網(wǎng)頁制作和網(wǎng)頁游戲開發(fā)。
具有10 年的Java 企業(yè)應用開發(fā)經(jīng)驗。曾經(jīng)歷任德國Software AG 技術顧問，美國Dachieve 系統(tǒng)架構師，美國AngelEngineers Inc. 系統(tǒng)架構師。
掃碼關注鍍金池微信號
手機訂課，優(yōu)惠多多
