提要
本文旨在压服工程师们，尤为是灵动团队的成员，在撰写流程文档时，抛却保守方法，试验行使：、Markdown撰写；、SVN/Git版本办理；、HttpSrvr排版；——合的新方法。
本文也描绘了关联的技巧因素：怎么不再翻开Offic或WPS，只要每每的记事本，相同写出摩登、易读的文章；怎么搭建一套Markdown-html的生成、颁布、和拜会系统；怎么行使扫瞄器马上、永远的拜会文档……
关键词
文档代码化markdowntochadranchor
目录
理论篇
文档的保守方法
文档的新方法
文档的代码化
实行篇
记号言语与Markdown
Markdwon东西软件
Markdown底子
办事流
一些技巧细节
附录
SublimTxt的根本行使
理论篇项目中的文档有许多种：须要/用户故事、计划计划、详细计划、接口注明、测试汇报……昔时的软件工程理论将这些文档摊派到不同的脚色身上；当代的灵动理论强调办事的软件高于详细的文档，考究文档的简明有用和脚色的彼此浸透兼并。本文不管两者的优劣，只想研讨一下怎么让写文档变的更便利、更喜悦这个话题，窃认为应当是对两派同窗都是有利益吧。
文档的保守方法回首一下咱们文档撰写、散发、扫瞄、革新的保守方法：
找到文档模板：比方是word/Excl/PowrPoint模版。至公司里不要小瞧了找模板的困苦，尤为是写跨部门、跨团队的文档，要找他人的模版时。找错的的话提交系统时被打回还要从头找。万一碰到了模版调换Logo一类的事件，用悬心吊胆来描绘有意候都不太甚。
把议论和札记写入文档：尽管有模版，但照旧会时时见到字体五光十色、行间距巨细不一、色彩五彩绚丽……应付这些题目，读者只可呵呵了（本文假设哪天写入了某个Word模版，确定也是个鬼样）。
合写文档的患难：每每的表面是：牵头人把章节定一下，在章节背面把详细撰写人的名字写上，商定个光阴，牵头人手工兼并。题目不言而喻啦：
手工兼并易失足
详细撰写人须要修正时会去费事牵头人，要末牵头人持续兼并，要末撰写人选用保守战术不再踊跃提交改变
兼并文档的版本办理困苦：通常会看到把日期加到文档后，相连串的日期把本人累的不可
“指定则节到撰写人”阻滞了撰写人写其余章节的踊跃性：由于会给兼并人带来更多的办事和混淆，撰写人宁肯维持低调；同时撰写人并不懂得另一章节的人是不是曾经撰写了本人料到的实质。
提交评审：挺好。但个中有一点须要改革：做家依照评审意见修正后，每每有两种方法评判是不是OK：把持人直接评判，把持人散会凑合评委们再次评判。——在一个柔和的团队中，这两种方法城市“谐和”的实行。也许增进第种意见表白的方法：评委直接修正文档，但是在word模版+没有版本办理的方法下，这是使人望而生畏的。
革新文档：最患难的部份到了
须要、计划类文档：开拓实行后回顾革新须要、计划的比例有多高？这个实际题目许多同窗宁肯提都不提，Ltitgo，随她吧。
详设、开拓类文档：软硬件工程师们拿各样理原故应付的场景信任都碰到过吧，甚么“来不及”了、“太多了”、“革新太快了”……以至再有“代码即文档”这类左倾冒险主义的假称不胜枚举。面临头领焚烧的怒气，工程师们用笑容和耸肩来抵御。
测试、汇报类文档：这个还好，由于是一次性行动的文档产品，根本不须要革新。《测试计划》归属到第一类中。
其余：技巧补偿、会议记要等流程文档，细想想更恐慌，几个月前议论的会议记要你还会翻开么？到何处找猜测都忘了吧，那次会议中的决心还记得么？前次调试碰到的失败写入技巧补偿了么？……呀呀呀，不要再说了。呵呵。
革新后文档的推送：有几种方法
第一次你是经过邮件、谈话软件把文档发给读者的，革新后的文档则须要重发一次，假设你一个月革新一次还好，假设一周革新一次呢？一天呢？
文档在某某系统中归档的：这就要依赖与该系统是不是好用、便利了。假设想读一个文档要投入系统中也许马上找到，Good；假设须要屡次跳转、或许要把握甚么奇技淫巧才行，就又要呵呵了，即是此次出来找到了，下次也许又找不到了。——在某某系统中迷过路的小火伴请举动手。
上头这些假设有哪条戳中了你的痛点，请接续往下读。假设你认为没干系啦，这些都是小事，鸡毛蒜皮的，咱们团队也许战胜，那就请不必往下看了，感谢！
文档的新方法目前，咱们来试想下一种新的方法：
写稿和排版是分散的：做家只关怀实质和简明的排版（如题目、分段、列表），不关怀终究的排版布局、字体色彩等展现表面（如颜色、字体、行间距……），相似竹素出书业：做家只要要把实质写在稿纸上或txt文本，编纂去实行排版和竹素的美工。如此带来的长处许多：
做家埋头于写实质、表白心思
编纂也许使得展现表面很简明统一
一个公司、一个部门、或一个团队也许便利的协议本人的衬托方法，写稿的人也许不必关怀。
调换Logo这类事件只要要编纂一团体做即是了。
编纂不是人，是软件、电脑
多人合写、配合是特别便利的：每团体的观念和主意也许便利的在团队中活动，关键是也许被纪录在文档中，而不是散落在邮件里。
每团体也许立即、实时的对文档中的实质表白意见。
团队中每团体均也许立即的收到文档被革新的告示，并且不须要撰写人发邮件告示，尤为在撰写人是多人的时分更为有用。
写稿是简文本表面的：随时、随地、随编纂器可翻开、编纂，再也不会浮目前一个没有安设Offic的电脑上打不开一个word文档、翻开文档后一个visio图是个血色叉叉……的囧境。
文档革新汗青信手拈来，毫厘不差：不必人为革新文档中的某个叫做“革新汗青”的章节，而是也许便利的看到该文档的整个介入人、介入光阴、和改正实质。——这可不是word的改正表面也许实行的。
经过扫瞄器拜会文档：翻开IE/Chrom/FF，拜会网址既能看到最新的文档，收藏到收藏夹中时通常看看，以至也许停止RSS定阅——这类扫瞄展现还不能感动你么？
OK，几大幻想怎么来实行呢？特别便利，咱们目前所处的互联网光阴早就搞定这些事件了，并且是特别简明、高效，须要的不过你勇猛的去试验、而后喜爱。
行使Markdown等记号类言语来写简文本文档：编纂器许多，也许参考下文“东西软件”章节，此处我举荐SublimTxt，Win/Mac/Linux全系统通用，恰当的加之各样插件，写甚么都特有感。
行使SCM(svn、git等)办理简文本文档：并不是甚么都能用SCM办理，最少软件版本、紧缩包、视频、以至图片……这些二进制的东西都是不能交给SVN、git来办理的，倒不是scm不能办理，而是你在做错的的事件，就像非要一个软件工程师去画一起电路板，不是他做不出来，而是你用人欠妥。简文本是svn/git最能接收的，并且长处多多：
多人合写文档：在svn/git提交即是了，updat一下，而后