微信号:programmer_club

介绍:程序员第一自媒体,与你探讨码农人生路上遇到的各类泛技术话题,定期为你推荐码农人生思考、感悟以及启迪!

程序猿的烦恼:怎样写出漂亮的文档?

2015-07-28 23:56 程序员之家

提示点击上方"程序员之家"关注我!


一直以来,程序员都有个文档情结,写文档时心中 100 只草泥马狂奔而过,可看别人项目时如果没有文档就开喷,又 100 只那什么马。


写文档是很痛苦的事情,维护文档又是一件更痛苦的事情。一般文档管理在项目开发中不是很受重视,当发现其重要性时,往往为时已晚。整个项目可能因此变得管理混乱,问题产生后无据可查。


总之,项目管理离不开文档,团队协作更离不开文档,就算你再不喜欢文档,但关键文档还是需要的,比如API文档,用户帮助手册等等。


所以我们需要有这么一个文档工具:


  • 多人在线协作 —— 几百页的文档都交给我一个人写,你们还是人吗?

  • 版本管理 —— v1/v2/v3/v2000 .....

  • 简单方便随时随地编写


为了解决文档给项目协作带来的困惑,OSChina 的 Team 团队协作工具推出了准备已久的“文档”的功能,通过 Team 的文档功能来沉淀团队资源,形成团队知识库的重要手段,但是千万不能用来写黄色,毕竟@红薯 才刚刚从警局里面出来。


你可以通过文档功能来做什么?


  • 编写项目竞标、需求、开发等文档

  • 编写 API 文档

  • 编写用户手册

  • 协作翻译电子书




目前Team的文档有以下功能:


1.基于markdown语法的拖拽组件,使得写文档变得非常有趣。


2.预设三大主题可以选择:Hexo、Daux、Single,让文档轻松变得高大上


3.支持导出markdown,pdf,word,html,另外也可以直接将文档同步到git项目的wiki,


4.支持高大上的自定义二级域名,xxx.mydoc.io。


5.可以多人协作编辑,防止同时编辑带来冲突,另外还有历史版本记录每次的编辑内容。


6.支持多级菜单,但为了文档美观,文档不建议太多级别


现在去开通Team —— http://team.oschina.net

Team文档在线演示地址:http://openapi.mydoc.io/

文档:http://teamdoc.mydoc.io/

 
程序员之家 更多文章 我们这一代人的困惑 神剪辑,揭秘程序员加班内幕,不能看,看完想笑又想哭! 美国12位创新型程序员:让科技永远改变 说说怎么写clean code 500,000+年薪程序猿出身哪里 猎聘网揭秘前十大学校
猜您喜欢 2016年十个最热门 IT 职业岗位 【第636期】一个靠谱的前端开源项目需要什么? C++11 | 从入门到放弃 坑系列 --- 高可用架构的银弹 58龙哥教你“如何做系统性能优化”(纯干货)