OurJS


OurJS-我们的JS, 我们的技术-IT文摘; 专注JS相关领域;
我们热爱编程, 我们热爱技术;我们是高大上, 有品味的码农;

欢迎您订阅我们的技术周刊


我们会向您分享我们精心收集整理的,最新的行业资讯,技术动态,外文翻译,热点文章;
我们使用第三方邮件列表向您推送,我们不保存您的任何个人资料,注重您的隐私,您可以随时退订,

欢迎分享您的观点,经验,技巧,心得

让我们一起找寻程序员的快乐,探索技术, 发现IT人生的乐趣;


本网站使用缓存技术每次加载仅需很小流量, 可在手机中流畅浏览;
如果您发现任何BUG,请即时告知我们: ourjs(at)ourjs.com

Readme文档驱动型开发


分享到


分类 心得体会   关键字 分享   发布 sasasamoa  1403241970975
注意 转载须保留原文链接,译文链接,作者译者等信息。  

这些天我听到了很多讨论,关于TDD,BDD,极限编程,Scrum,站立会议和各种为了开发更好的软件的方法论及技术,但它们都是无关紧要的,重要的是我们正在构建的软件能够满足一些人的需求。让我换另一种方式说吧。如果采纳了错误的需求,那就是毫无价值的。根据同样的原理,一座精巧美丽的图书馆如果没有任何书籍也毫无价值。如果您的软件解决了错误的问题或没有人能知道怎么使用,这都是很糟糕的事情。


好的。那么,我们如何解决这个问题?这比你想象的更容易,其实你只需要一段话就可以了。 


首先,写一个自述(readme)

第一,正如你在编写任何代码或进行测试或其它任何事情之前。我知道,我知道,我们是程序员,该死的,不是高科技的作家!但是,这你就错了。写简介对于编写一个好的软件是绝对必要的。直到你先写点关于你软件的东西,不然你不知道你在写什么代码。在反对瀑布设计,敏捷开发和验收为王之间,一些东西丢失了。不要误会我的意思,瀑布设计需要太多的东西。庞大的系统最终会在微小的细节中产生的错误而结束。我们的罢工是正确的,取而代之的是偏离正确的方向太远太远,我们只有一些短的,写的不好的,或者完全丢失的文档的项目。有些项目甚至没有一个自述!


这是不能接受的。在必须有规格书和没有规格书之间肯定有一个界限。而事实上是这个界限就是不起眼的自述。


正确地区分自述文档(RDD)驱动和文档驱动(DDD)是非常重要的。 RDD可以考虑被认为是DDD的一个子集或有限的DDD版本。通过将你的设计文档变成一个简短的文件,就像是介绍你软件的简介一样,RDD通过去除你冗长或过于精准的规范,让你从DDD的瀑布综合症中保持安全。与此同时,它使你保持简单,模块化。这些简单的功能的叠加,推动你在正确的方向上前行,无需大量工作以确保你做正确的事情。


通过你的自述,你会得到一些非常显著的优势:


1 最重要的是,你应该给自己一个机会来思考,通过无需每次改变代码的来进行这个项目,你写g步关于业务应当如何组织或者什么应该包括在公共API中的想法。还记得当你第一次开始编写自动化代码测试,并且意识到你会抓住那些可能会悄悄进入到你的代码的错误时的感觉吗?这时你将会拥有的完全一样的感觉,如果,在你写的实际代码之前,写下一份自述文件。


2. 作为一个为了让你知道需要实现什么功能而写的Readme,其实会变成一份非常漂亮的文档摆在你面前。如果你在项目开始时写,就不会费什么力,它在你兴奋和激动时写起来更容易。否则它就是一个绝对的阻力,当你这想起来的时候,你一定会错过各种重要的细节。


3. 如果你正在跟团队一起开发,你可以从你的自述文件获得获得更多额外的东西。在你完成这些项目之前,团队的其他人能够访问这些信息,那么他们就可以放心地开始其他方面的工作,而不需要等你 接口好了再进行,他们只需要你自述里定义的一个抽象接口。


4. 有根据写下来的东西进行讨论是一个简单得多的事情。否则很容易滔滔不绝,并为了一个问题兜圈子,如果没有什么是付诸文字。写下一个提议的解决方案是最简单的, 意味着每个人都拥有一个具体的想法,可以争论,可以迭代。


考虑为您的自述文件写在真正动手之前。这里是你展现杰出的想法的地方。此文件应作为证明你创造力和表现力的基石。自述应该是在你的代码库中最重要的文件; 首先写好它是你要做的最正确,最恰当的事情。


原文地址: 点此
社区评论 ( Beta版 )
OnceDoc 您自己的企业内容管理系统——文档、流程、知识库、报表、网盘All In One

访问404页面,寻找丢失儿童
 热门文章 - 分享最多
  1. 我不想雇佣女性
  2. 皇帝的新衣:Node.js
  3. 如何兼职创业并避免风险
  4. PHP vs Node.js:真正的评测数据
  5. 沃尔玛为什么要采用Node.js
  6. DevOps:全能开发是如何扼杀程序员的
  7. Swift的前世今身-创始人的自述
  8. JavaScript中NaN的秘密
  9. 在JavaScript中创建命名空间的几种写法
  10. Intel: Javascript将全面支持SIMD
  11. 用 OnceAir 搭建个人Git/Svn/照片备份服务器,每年电费7块钱

 相关阅读 - 心得体会
  1. 皇帝的新衣:Node.js
  2. “设计师思维”正在毁灭我们
  3. 现在,你为什么应该学Node.js
  4. 7件你不知道但可以用CSS做的事
  5. NODEJS是人性化的
  6. 用JavaScript的5个原因
  7. 告诉你为什么要合并样式文件的另一个原因
  8. 干嘛不在企业中使用Node.js呢?
  9. 你用什么工具开发JavaScript?
  10. 一系列JavaScript的基础工具

 关键字 - 分享
  1. Node初学者入门,一本全面的NodeJS教程
  2. IE、Chrome、Firefox浏览器默认首页被改成360导航解决办法(删除daohang88.com)跳转
  3. C语言用指针模拟按引用传递int整型参数
  4. Redis只往zset有序集合添加不存在的数据:关键字索引查询构建+源码分析
  5. redis5.x新特性,Stream流数据类型使用简单教程
  6. 一位自由职业者的分享:程序员怎样找兼职?
  7. 对于现代开发来说,JavaScript就是一种垃圾语言
  8. 我为什么不再用Compass写CSS(缺点分析)
  9. Redis/Python被要求更改Master/Slave程序接口名称和描述
  10. 程序员疑似将MySQL用户名密码上传至Github,导致华柱1.3亿条开房数据泄漏

 欢迎订阅 - 技术周刊

我们热爱编程, 我们热爱技术; 我们是高端, 大气, 上档次, 有品味, 时刻需要和国际接轨的码农; 欢迎您订阅我们的技术周刊; 您只需要在右上角输入您的邮箱即可; 我们注重您的隐私,您可以随时退订.
加入我们吧! 让我们一起找寻码农的快乐,探索技术, 发现IT人生的乐趣;


 关注我们

我们的微信公众号: ourjs-com
打开微信扫一扫即可关注我们:
IT文摘-程序员(码农)技术周刊

ourjs官方微信号