文檔那么多懦尝,該怎么整理

以下內容基本都是通過訊飛語記來實時翻譯,再copy后編輯排版壤圃,可能存在很多口語話內容陵霉,純屬正常現(xiàn)象伍绳。
image.png

不管是不是做開發(fā)踊挠,都遇到很多時候需要做比較,你是怎么樣來保存你的筆記資料呢冲杀?

開發(fā)其實會涉及到很多的文檔的一些編寫或整理效床,比如說,我們啟動一個項目要怎么展望目標权谁,然后如何規(guī)劃一些細節(jié)剩檀,再然后到項目的分工,項目的產(chǎn)品文檔旺芽,數(shù)據(jù)文檔沪猴,賬號平臺等資料保存卤妒,API文檔的說明,系統(tǒng)開發(fā)后的操作文檔整理等等字币,對了则披,還有過程中參考用到的一些資料,學習到的內容的歸檔等洗出,這些都需要大量的文檔保存士复。

些所有呢,在最后可能都是通過文檔的方式來保存下來才能更方便自己或者給到別人來閱讀了解翩活,如果按以前的方式都是通過word文檔的方式來處理阱洪,那有個也有好也有壞,好處是我可以隨時發(fā)給別人菠镇,但是壞處是有可能在大批量的內容統(tǒng)一做調整或者目錄結構發(fā)生變化時候冗荸,不是很好的去做變更,這樣導致內容維護起來沒有溯源或者存在很多重復copy利耍。

那有沒有一個方式或工具能夠滿足我們對知識庫的管理蚌本,這個文檔庫一直能保持是最新的一個狀態(tài),或者說我能隨時的追溯到以往的一些記錄隘梨,能夠保證所有的信息都是在最新的程癌,最有用的,而且又是最全面的轴猎。
可能很多人會想到或者已經(jīng)用到例如 印象筆記嵌莉、有道筆記、熊掌記捻脖、Notion 等锐峭,的確這些都是非常優(yōu)秀的工具,但好像又缺了點什么可婶。如果我想我的API文檔能本地隨時保存好沿癞,又能發(fā)布到類似簡書這樣的平臺,又可以單獨拿出來整理成API文檔手冊發(fā)布扰肌,并且這些操作的切換抛寝,其格式還能保存一致,這樣對于別的工具來說可能就不一定那么便利了曙旭。
這里我介紹一套組合拳 Docsify + Gitee

首先我們要掌握Markdown語法

markdown語言盗舰,它的語法是非常的簡單,它有統(tǒng)一的標準比類似我們的html這樣的一些語法桂躏,但是那比html更簡單钻趋,它主要是針對在內容格式上的一個最簡約的維護,能保證我們本地和簡書還是其他支持markdown語法的平臺or工具都能統(tǒng)一內容的顯示格式

markdown的語法: http://markdown.p2hp.com/basic-syntax/

其次學會用Dosify 來組織文檔結構

Docsify 是一個動態(tài)生成文檔網(wǎng)站的工具,支持本地編輯的內容文檔的實時預覽

https://docsify.js.org

最后學會用Gitee 保存內容已經(jīng)發(fā)布到Gitee pages以便在線瀏覽

國內的Git庫剂习,保證打開的速度以及能將文檔的撰寫記錄一點一滴都記錄下來

http://gitee.com

image.png

logo_gitee_light.png

這樣的話蛮位,我們自己的知識庫就可以開始搭建起來了较沪。
去新建一個git庫同步到本地后,新建docs 文件夾失仁,

docsify init ./docs

初始化為docsify的根目錄尸曼,得到 _sidebar.md 和index.html 文件,分別為菜單目錄文件和未來web訪問的首頁萄焦。
可以通過

docsify serve ./docs

來本地預覽控轿,對了,編輯的文件工具可以用vscode 或者其他可視化的markdown編寫工具拂封。這里邊設計到如果要圖片上傳的話哦茬射,本地保存,發(fā)布到線上去可能會導致圖片丟失冒签,最好的方式就是圖片都是引用外部鏈接在抛,保持本地和線上體驗一致。[todo]這個未來可以展開下圖片怎么保存和獲取訪問地址萧恕。

Git庫結構

這樣我們可以保證內容文檔隨著開發(fā)的進度可以不斷修改補充刚梭。

`

教你如何使用docsify快速部署優(yōu)美的在線文檔

https://www.cnblogs.com/summerday152/p/14008463.html
`

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市廊鸥,隨后出現(xiàn)的幾起案子望浩,更是在濱河造成了極大的恐慌,老刑警劉巖惰说,帶你破解...
    沈念sama閱讀 206,214評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異缘回,居然都是意外死亡吆视,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評論 2 382
  • 文/潘曉璐 我一進店門酥宴,熙熙樓的掌柜王于貴愁眉苦臉地迎上來啦吧,“玉大人,你說我怎么就攤上這事拙寡∈谧遥” “怎么了?”我有些...
    開封第一講書人閱讀 152,543評論 0 341
  • 文/不壞的土叔 我叫張陵肆糕,是天一觀的道長般堆。 經(jīng)常有香客問我,道長诚啃,這世上最難降的妖魔是什么淮摔? 我笑而不...
    開封第一講書人閱讀 55,221評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮始赎,結果婚禮上和橙,老公的妹妹穿的比我還像新娘仔燕。我一直安慰自己,他們只是感情好魔招,可當我...
    茶點故事閱讀 64,224評論 5 371
  • 文/花漫 我一把揭開白布晰搀。 她就那樣靜靜地躺著,像睡著了一般办斑。 火紅的嫁衣襯著肌膚如雪厕隧。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,007評論 1 284
  • 那天俄周,我揣著相機與錄音吁讨,去河邊找鬼。 笑死峦朗,一個胖子當著我的面吹牛建丧,可吹牛的內容都是我干的。 我是一名探鬼主播波势,決...
    沈念sama閱讀 38,313評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼翎朱,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了尺铣?” 一聲冷哼從身側響起拴曲,我...
    開封第一講書人閱讀 36,956評論 0 259
  • 序言:老撾萬榮一對情侶失蹤愿汰,失蹤者是張志新(化名)和其女友劉穎翩迈,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體棋嘲,經(jīng)...
    沈念sama閱讀 43,441評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡店溢,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,925評論 2 323
  • 正文 我和宋清朗相戀三年叁熔,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片床牧。...
    茶點故事閱讀 38,018評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡荣回,死狀恐怖,靈堂內的尸體忽然破棺而出戈咳,到底是詐尸還是另有隱情心软,我是刑警寧澤,帶...
    沈念sama閱讀 33,685評論 4 322
  • 正文 年R本政府宣布著蛙,位于F島的核電站删铃,受9級特大地震影響,放射性物質發(fā)生泄漏册踩。R本人自食惡果不足惜泳姐,卻給世界環(huán)境...
    茶點故事閱讀 39,234評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望暂吉。 院中可真熱鬧胖秒,春花似錦缎患、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至风题,卻和暖如春判导,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背沛硅。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評論 1 261
  • 我被黑心中介騙來泰國打工眼刃, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人摇肌。 一個月前我還...
    沈念sama閱讀 45,467評論 2 352
  • 正文 我出身青樓擂红,卻偏偏與公主長得像,于是被迫代替她去往敵國和親围小。 傳聞我的和親對象是個殘疾皇子昵骤,可洞房花燭夜當晚...
    茶點故事閱讀 42,762評論 2 345

推薦閱讀更多精彩內容