Markdown+Pandoc+Sphinx+ Git 协作写书式推进团队技术文章

让写技术文章成为大家的一种工作习惯和方式。

yestone_HD_1133212058_jpg_heading
yestone_HD_1133212058_jpg_heading

解决问题##

促进个人,团队,大团队技术博客的建设:

  1. 习惯成自然, 先要有习惯,然后才能成为自然。
  2. 习惯要容易养成,利用技术人员写笔记做积累的特点和相应项目需要技术文档的特性,和工作紧密结合,让写文章就像写代码一样。
  3. 寻找一种方便的方式将每个人以及项目的积累以标准整理输入。
  4. 积少成多,建立机制自然的汇聚,让每个人是小溪,小团队是小河,大团队的ATA是我们的大江。
  5. 思想和笔记需要一定的积累和加工,按照写书的思路,让大家有合作编辑和评审的参与感,才能有高质量的文章产出。

建议##

以MarkdownPad + Pandoc + Sphinx + Git的的标准方式推进,这是目前很多开源软件的技术文档的协作方式。

技术特点###

  1. 以git管理文章内容,技术人员很习惯也也便于管理。

  2. 以Markdown为文章格式,MardownPad等工具很适合大家本地编写。

  3. Pandoc可以做各种格式的转换,比如输出层pdf。

  4. Sphinx可以方便讲各种文章以书籍的格式整理,并产出高质量的在线阅读格式。

  5. 很好的表格支持,markdown对table支持不够,sphinx对table以及自定义table有很强的支持。

具体可参考示范。

期望目标##

  1. 每个人以这种方式做平时的技术笔记整理,让个人养成习惯。团队以这种方式像协作写书一样做团队技术博客文集,团队之间形成良性竞争,看哪个团队的文集产出和质量最高。

  2. 这些产出都会输出到团队的ATA上,同时也能成为自身团队的技术积累。

  3. 这种方式也可以向整个技术部推荐,进而成为集团内标准的技术文档管理规范。

如何更好的激励##

需要大家更多的意见...

示例和源码##

安装

  1. 安装pandoc,http://www.pandoc.org/
  2. 安装python和easy_install.

http://www.baidu.com/link?url=IYtjch8TRUjvhqpGEFAJgT7744EBFqyq5y3uT1w2PUbxk0DlSqQQ32Xok0C58F9fj-b7ySNDg99UmvI_BoKGMYnzkzhM8OBpu6_frWRQRRi&wd=&eqid=c14c359a00093e7e00000005565696ba

  1. 运行easy_install安装sphinx和pip

    easy_install sphinx
    easy_install pip

这个过程有失败可以多试验几次。

  1. 在文档目录里,运行make clean ; make html构建文档
_2016_03_19_15_26_21
_2016_03_19_15_26_21

参考资源##

Makedown 本地工具: MarkdownPad
Pandoc: www.pandoc.org(Sphinx 依赖)必须先安装。
Sphinx: http://sphinx-doc.org/ 具体参考Sphinx安装。 依赖python, pip, pandoc.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,784评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,745评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,702评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,229评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,245评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,376评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,798评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,471评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,655评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,485评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,535评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,235评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,793评论 3 304
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,863评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,096评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,654评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,233评论 2 341

推荐阅读更多精彩内容