记录问题解决日志
——
高效程序员的
45
个习惯之习惯33
“在开发过程中是不是经常遇到似曾相识的问题?这没关系。以前解决过的问题,现在还是可以解决掉的。”
面对问题(并解决它们)是开发人员的一
种生活方式。当问题发生时,我们希望赶紧把它解决掉。如果一个熟悉的问题再次发生,我们会希望记起第一次是如何解决的,而且希望下次能够更快地把它搞定。
然而,有时一个问题看起来跟以前遇到的完全一样,但是我们却不记得是如何修复的了。这种状况时常发生。
不能通过
Web
搜索获得答案吗?毕竟互联网已经成长为如此令人难以置信的信息来源,我们也应该好好加以利用。从
Web
上寻找答案当然胜过仅靠个人努力解决问题。可这是非常耗费时间的过程。有时可以找到需要的答案,有时除了找到一大堆意见和建议之外,发现不了实质性的解决方案。看到有多少开发人员遇到同样的问题,也许会感觉不错,但我们需要的是一个解决办法。
要想得到更好的效果,不妨维护一个保存曾遇到的问题以及对应解决方案的日志。这样,当问题发生时,就不必说:“嘿,我曾碰到过这个问题,但是不记得是怎么解决的了。”可以快速搜索以前用过的方法。工程师们已经使用这种方式很多年了,他们称之为
每日日志
(
daylog
)。
不要在同一处跌倒两次 Don't get burned twice
可以选择符合需求的任何格式。下面这些条目可能会用得上。
-
问题发生日期。
-
问题简述。
-
解决方案详细描述。
-
引用文章或网址,以提供更多细节或相关信息。
-
任何代码片段、设置或对话框的截屏,只要它们是解决方案的一部分,或者可以帮助更深入地理解相关细节。
要将日志保存为可供计算机搜索的格式,就可以进行关键字搜索以快速查找细节。图
7-1
展示了一个简单的例子,其中带有超链接以提供更多信息。
图
7-1
带有超链接的解决方案条目示例
如果面临的问题无法在日志中找到解决方案,在问题解决之后,要记得马上将新的细节记录到日志中去。
要共享日志给其他人,而不仅仅是靠一个人维护。把它放到共享的网络驱动器中,这样其他人也可以使用。或者创建一个
Wiki
,并鼓励其他开发人员使用和更新其内容。
维护一个问题及其解决方案的日志。
保留解决方案是修复问题过程的一部分,以后发生相同或类似问题时,就可以很快找到并使用了。
切身
感受
解决方案日志应该作为思考的一个来源,可以在其中发现某些特定问题的细节。对于某些类似但是有差异的问题,也能从中获得修复的指引。
平衡的艺术
-
记录问题的时间不能超过在解决问题上花费的时间。要保持轻量级和简单,不必达到对外发布式的质量。
-
找到以前的解决方法非常关键。使用足够的关键字,可以帮助你在需要的时候发现需要的条目。
-
如果通过搜索
Web
,发现
没人
曾经遇到同样的问题,也许搜索的方式有问题。
-
要记录发生问题时应用程序、应用框架或平台的特定版本。同样的问题在不同的平台或版本上可能表现得不同。
-
要记录团队做出一个重要决策的原因。否则,在
6~9
个月之后,想再重新回顾决策过程的时候,这些细节就很难再记得了,很容易发生互相指责的情形。
摘自:http://turingbooks.iteye.com/blog/548698
分享到:
相关推荐
【优秀程序员45个习惯】是一本旨在提升程序员专业素养的书籍,由敏捷开发领域的权威Venkat Subramaniam和Andy Hunt共同撰写。这45个习惯覆盖了态度、学习、开发流程、用户、编程以及团队协作等多个方面,旨在帮助...
程序员表白神器你值得拥有-程序员表白神器你值得拥有 程序员表白神器你值得拥有-程序员表白神器你值得拥有 程序员表白神器你值得拥有-程序员表白神器你值得拥有 程序员表白神器你值得拥有-程序员表白神器你值得拥有 ...
本书名为《高效程序员的45个习惯 敏捷开发修炼之道》,由Venkat Subramaniam和Andy Hunt两位作者共同撰写。书中所提到的45个习惯,不仅涉及软件开发过程、编程和调试工作,还包括了开发者的个人态度、项目和团队管理...
【优秀程序员的十个习惯】 1. 持续学习与跟进新技术:作为优秀程序员,保持对新知识的渴望至关重要。不断学习新的编程语言、框架和工具,关注行业动态,参与专业社区讨论,如CSDN、ITPUB、CHINAUNIX、digg.com等,...
本资源"程序员开发之路之---手机顶尖游戏制作全揭秘"显然是一个深入探讨这一主题的资料集合,可能包括教程、案例分析等内容。 首先,我们要理解手机游戏制作的基本流程。通常,这始于游戏概念的诞生,包括游戏类型...
程序员简历模板10份--蓝色主题 各不相同 程序员简历模板10份--蓝色主题 各不相同 程序员简历模板10份--蓝色主题 各不相同 程序员简历模板10份--蓝色主题 各不相同 程序员简历模板10份--蓝色主题 各不相同 程序员简历...
WINDOWS程序员使用指南(三)----OLE_DDEWINDOWS程序员使用指南(三)----OLE_DDE
WINDOWS程序员使用指南(五)----OBJECT WINDOWS库WINDOWS程序员使用指南(五)----OBJECT WINDOWS库
通过这个示例,我们可以看到,工作日志可以帮助程序员更好地管理自己的工作,提高工作效率,记录工作进度,总结工作经验等。 结论 工作日志是程序员日常工作中不可或缺的一部分,它可以帮助程序员更好地管理自己的...
简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选简历模板-程序员-通用-精选...
软件工程课程设计---学生管理系统--程序员SUMER 软件工程课程设计---学生管理系统--程序员SUMER 软件工程课程设计---学生管理系统--程序员SUMER 软件工程课程设计---学生管理系统--程序员SUMER 软件工程课程设计---...
- **记录事项**:养成良好的记录习惯,及时记录下需要完成的任务或注意事项,避免遗忘造成的压力。 - **备份钥匙**:准备备用钥匙,防止丢失钥匙时产生的不便和焦虑感。 - **应急准备**:为可能出现的问题做好应急...
软件工程课程设计-----Release.rar --程序员SUMER 软件工程课程设计-----Release.rar --程序员SUMER 软件工程课程设计-----Release.rar --程序员SUMER 软件工程课程设计-----Release.rar --程序员SUMER 软件工程课程...
成为优秀的程序员不仅在于编写高质量的代码,更重要的是养成一系列有益的习惯,这些习惯能够提升个人技能,促进团队协作,以及保持对技术的敏锐度。以下是对标题和描述中提到的十个程序员习惯的详细解释: 1. **...
优秀程序员的45个习惯.rar ok good
WINDOWS程序员使用指南(二)----MICROSOFT基本类库WINDOWS程序员使用指南(二)----MICROSOFT基本类库
程序员必备技能----断点调试(IDEA版)---- 代码
在学习这些书籍时,读者需要具备一定的数学基础和编程基础,熟悉编程语言和数据结构,并且需要具备一定的逻辑思维和问题解决能力。 程序员的数学系列书籍是一个非常有价值的资源,对程序员和计算机科学家非常有帮助...