5. 写文档
在说这个条目之前我先承认,我们确实有很多的文档生成工具,但据我的
经验,这些工具都是只适合生成
API 文档,以供其他程序员参考。如果你开发
的软件是平时人们每天都要用的,你必须要写一些外行人
(例如你的实施,客服
等
)都能理解的文档手册。
我们可以很容易的看出,有些事情程序员们极不愿意去做。 你可以简单的
回顾一下所有的开源项目。 人们百折不挠的对这些项目的一个索求是什么:文
档。
我敢打保票的说,不管在哪里,至少会有一半的程序员当要求写文档时会
“
说: 不能让其他人去写吗
?“。
6.
—
程序
缺少文档
我可从来没说过我们程序员是说一套做一套的人。 程序员们经常会在他们
的项目里用到第三方的类库和应用。 于是,我们需要文档。 很不幸呀,就像我
在第
6 条里说的那样,程序员们痛恨写文档。这戏剧性的事情发生在我们自己身
上。
当你需要使用一个第三方类库时发现,至少有一半的
API 无从知道是干什
么好用的,没有任何事情比这个更打击人的了。函数
poorlyNamedFunctionA()
和函数
poorlyButSimilarlyNamedFunctionB()
有什么区别
?
在我使用
PropertyX
属性前是否需要测试一下它是不是
null 值?
我估计只有通过自己的测试和报错才能弄清楚
!可恶。
7. 硬件
任何一个曾经被叫去调试一个数据库
上奇怪的宕机现象,或是被叫
去解决
RAID驱动器不能正确的工作的问题的程序员,当发现是硬件问题时,都
会痛苦不已。 人们有一种普遍的误解,认为程序员就是搞电脑的,他们肯定知
道如何修理电脑。不可否认,有些程序员确实是个全才,但我估计,绝大部分程
序员都不知道,或者根本不关心当程序被编译成机器码后如何工作的。我们只关
心做出来的东西是否符合需求文档,这样我们才能集中精力去解决这上层的任
务。
8. 含糊不清
“
”
网站宕机了
. “XX
”
功能工作不正常 。 处理含糊不清的任务是种痛苦。 每
次当非程序员被要求重现他们所遇到的问题时表现出的愤怒都让我吃惊不已。
”
他们似乎不太明白,仅仅一句 它宕机了,修复它
!”是无法让我们开始工作的,
我们需要更多的信息。