关于markdown写软件文档你怎么看?

问题描述

大多数Coder都讨厌写文档,更让人痛恨的是文档随着迭代开发进程或者项目进展,要持续修订,而且修订还是多人协作,修订后的内容合并更是吐血,这又加剧了程序员对写文档的痛恨程度。最近有个想法,把原本word格式的开发文档拆分成一堆遵循markdown语法的文本文件,然后把它们当做普通的程序源码控制起来,以此提高开发团队在文档编写方面的工作效率和工作质量。大家对这个举措怎么看?是否可行?

解决方案

解决方案二:
拿着模板扒呗
解决方案三:
如果文档都规范了,就不会那么麻烦,关键是大家都不愿意认真写文档,所以从一开始就预示着文档是个头疼的问题

时间: 2024-11-05 18:56:43

关于markdown写软件文档你怎么看?的相关文章

markdown js:使用Strapdown.js和markdown写极简静态博客

有些新手认为使用markdown建站有个缺陷是需要服务器支持,如jeklly或higridcms等,其实higrid认为并不是这样的.对只有静态空间的朋友,higrid介绍一个静态渲染markdown的利器,就是Strapdown.js.使用Strapdown.js是markdown to html的javascript,并且带有界面效果,不需要你写CSS样式,只要在html页面里面写markdown,他就會把你寫的文字解析然后在浏览器呈现出用户体验良好的布局.使用Strapdown.js和ma

c# com组件-求助c#写com组件有毒 看了无数文章也无法公开一个类中的函数

问题描述 求助c#写com组件有毒 看了无数文章也无法公开一个类中的函数 看了无数文章和博客尝试了无数方法依然无法解决这个问题 编译的com组件永远只有 _object 下的的几个函数自定义的函数一个也没有 下面是看着无数文章写的代码 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Run

markdown-最近用Markdown写博客,总是无法保存,有人碰到类似问题吗?

问题描述 最近用Markdown写博客,总是无法保存,有人碰到类似问题吗? 最近用Markdown写博客,点保存,然后开始漫长地等待,最后就是 发表博客出现异常,请重试! A timeout occurred. 我换了好几个浏览器,都是没有用, 有人遇到类似问题吗? PS:CSDN的客服反应好慢啊,我给他们发消息,一个礼拜了都没有人回复. 解决方案 呃,表示没问题.. 如果保存不了建议你可以直接发出来,然后再修改= =

用link写个函数,实现>>>运算的功能,这个函数怎么写?能不能写下给我看,谢谢

问题描述 用link写个函数,实现>>>运算的功能,这个函数怎么写?能不能写下给我看,谢谢 用link写个函数,实现>>>运算的功能,这个函数怎么写?能不能写下给我看,谢谢 解决方案 是向右移位,左边补0,需要先对符号位做一个判断.

学会用markdown写博文

带学生将互联网用于学习已经几个年头了.大一的学生就通过发博客,积累代码行.以此,打开了了解行业的窗口.有些同学注意到了发博客时,还可以查看"源文件",了解到了HTML,然后开始尝试自己写标记,做一些特殊的处理. 这是未来专业人员可以尝试做的事. CSDN推出了markdown编辑器.markdown在2013年写作<逆袭大学>时就用过,的确作为轻量级的写作平台,体验很好.所以,我近几月的博文,全部用markdown完成.整理好文字.代码,简单的一点操作,博文发布成功. 想让

刚运行了 Azureus ,给我的感觉是这界面真不象是Java 写的,发誓看完这套代码!

最近在学习P2P方面的知识,所以有了分析P2P软件源码的冲动啊! 呵呵,其实我看 Azureus 有两个原因,一是他是Java 写的,而eMule是C++写的,我对C++不是很熟悉, 怕理解上没有 Azureus 理解上来的快, 二是看crmky 的Blog 上有对 Azureus 的分析,他说不错,恩,那就 瞧瞧啦!,呵呵 Crmky  对 Azureus 的评价如下: 读Azureus源码因为要构架公司的P2P框架,所以想先阅读已有的Java P2P软件代码,看看有什么可借鉴之处.头一个值得

谈谈如何写出一篇看不见任何广告语的软文

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 现在很多用户都不相信论坛.博客上面的文章,因为论坛与博客上面的文章的广告语都太裸露了,用户一看就知道是假的,对用户购不成任何的吸引力.我们可以在QQ群中很清晰的看到,以前在QQ群中发一则广告语能够吸引群里面的人进行点击,而现在吸引的不是点击而是直接问您的东西有作用吗?您的东西谁敢买啊等等词语,从中我们可以分析出:裸露的软文已经不适合用户需要,

调侃985_不是我写的,我仅看过,呵呵

1 东方不败是清华, 朝上有人好提拔. (清华大学) 2 最敢放炮是北大, 媒介政坛爱自夸. (北京大学) 3 顾影自怜复旦花, 坐吃山空穷人家. (复旦大学) 4 来者不拒是浙大, 大杂烩里要数他. (浙江大学) 5 咸鱼翻身上交大, 拽着主席抬身价. (上海交通大学) 6 金玉其外是南大, 炮制论文网上挖. (南京大学) 7 党国大学中山大, 海外校友最庞大. (中山大学) 8 自以为是中科大, 崇洋媚外海外爬. (中国科技大学) 9 昙花一现华科大, 怨天尤人没身价. (华中科技大学) 1

vim 环境写 markdown 的插件推荐

vim 环境写 markdown 的插件推荐 本文将介绍在vim环境写markdown文档或者博文的一些好用插件 markdown语法高亮及识别 博主使用vim-markdown做语法高亮.安装方法很简单,这里以pathogen为例: cd ~/.vim/bundle git clone https://github.com/plasticboy/vim-markdown.git 安装完以后plugin自动由pathogen生效,由于我们是用markdown写jekyll博客,这里需要额外对YA