一直以來,程式員都有個文檔情結,寫文檔時心中 100 隻草泥馬狂奔而過,可看别人項目時如果沒有文檔就開噴,又 100 隻那什麼馬。
寫文檔是很痛苦的事情,維護文檔又是一件更痛苦的事情。一般文檔管理在項目開發中不是很受重視,當發現其重要性時,往往為時已晚。整個項目可能是以變得管理混亂,問題産生後無據可查。
總之,項目管理離不開文檔,團隊協作更離不開文檔,就算你再不喜歡文檔,但關鍵文檔還是需要的,比如api文檔,使用者幫助手冊等等。
是以我需要有這麼一個文檔工具:
多人線上協作 —— 幾百頁的文檔都交給我一個人寫,你們還是人嗎?
版本管理 —— v1/v2/v3/v2000 .....
簡單友善随時随地編寫
為了解決文檔給項目協作帶來的困惑,team 推出了準備已久的“文檔”的功能,通過team的文檔功能來沉澱團隊資源,形成團隊知識庫的重要手段,但是千萬不能用來寫黃色,畢竟@蕃薯 才剛剛從警局裡面出來。
你可以通過文檔功能來做什麼?
編寫項目競标、需求、開發等文檔
編寫 api 文檔
編寫使用者手冊
協作翻譯電子書
https://yqfile.alicdn.com/dc70c8bd96de4819fa455f2503c6271cc5a77060.png" >
目前team的文檔有以下功能:
1.基于markdown文法的拖拽元件,使得寫文檔變得非常有趣。
https://yqfile.alicdn.com/1bdbbab3062bc6bcc68e8fbf72ab1dcb32e719b7.png" >
2.預設三大主題可以選擇:hexo、daux、single,讓文檔輕松變得高大上
3.支援導出markdown,pdf,word,html,另外也可以直接将文檔同步到git項目的wiki,
4.支援高大上的自定義二級域名,xxx.mydoc.io。
5.可以多人協作編輯,防止同時編輯帶來沖突,另外還有曆史版本記錄每次的編輯内容。
6.支援多級菜單,但為了文檔美觀,文檔不建議太多級别