开发文档怎么编写_我的软件开发日常工作随笔

从事软件开发工作已经有好几年了，学到了很多，也积累许多工作经验，也养成了一些日常做事的习惯。下面我就日常工作的事情做个简单的分享。

关于排查问题

最近两年对各种软件运行中的疑难问题和异常崩溃比较感兴趣，系统的学习了相关理论知识，掌握了Windbg和IDA等辅助工具的使用，也逐渐接管了部门这一块的工作内容。

在问题中提升，在问题中进步。在多接触各式的疑难问题后，会去做很多相关的钻研和思考，在排查问题的过程中积累多方面的经验，知晓多种bug的各种诱因之后，在后续编写代码的过程中也会下意识的提高代码的质量。

在排查问题的过程中，我不仅仅关注我们团队负责的模块，我也会关注其他团队的模块，一方面是为了扩大眼界、扩大知识面，另一方面也能借鉴其他团队比较好的思路和软件设计思想。即便是其他团队的模块导致的问题，我也会去问个一清二楚，这有利于熟悉公司整体的业务，以便以后排查问题更加得心应手。而且也能吸取各种代码缺陷的教训，敦促自己写出质量更好的代码。

公司的同事在遇到疑难问题和软件异常崩溃时，也会主动邀请我去协助他们排查，去帮他们分析可能存在的问题。有时为了搞清楚问题的来龙去脉，我会详细询问他们负责模块的业务和框架设计，有时同事也会开玩笑的说，“你这个人有点危险啊，怎么什么事情都想知道，好奇心太大，你是不是要抢我们的饭碗啊！”

在排查问题的过程中，也有会有意识的去涉猎一些自己岗位涉及不到的东西。比如我在看平台开发或平台测试的同事在分析问题时，都用了哪些Linux命令和分析手段，我会把一些要点记录下来。我会去学别人在排查网络问题时是如何分析wireshark抓取的网络数据包以及定位问题的思路。我也会去关注别人在排查问题时都使用了哪些工具，会去了解这些工具是怎么用的，以及怎么通过这个工具去辅助排查的。

公司的同事也会主动将他们排查到的问题原因和我分享，这也使得我有机会去了解更多的问题，积累更多的经验。这样就形成一个良性循环！我为人人，人人为我！

排查过的问题越多，见识的就越多，排查新问题的思路也就越多！

关于问题的记录与总结

平时上班时排查问题，我会记录一下排查过程中一些要点，保存一些关键数据截图(整理文章时要图文并茂才能更好的说明问题)，周末时我会详细做技术总结，会整理成文档记录下来。

在总结时，我会详细记录问题的场景，会进行详细的思考，尽量搞清楚问题的来龙去脉，还会和以前遇到过问题做比较，总结出一些排查问题的思路和常用方法。比如我会结合以往排查出的问题，总结引起软件异常崩溃都有哪些常见的原因。再比如我会总结一些加打印、分段注释代码、调试手段等常用的排查手段和方法。这两方面东西，后面我会做两个专项总结，然后在头条上分享出来，给软件开发新人们提供一定的帮助。

之所以要整理成word文档，一方面是因为在总结编写文档的过程中能加深对问题的理解和认知，另一方面也方便以后遇到问题时回过头来查阅。正所谓，好记性不如烂笔头！

以前喜欢直接记录在纸质的本子上，但是查阅起来很不方便，所以后来就直接整理成电子word文档，需要查阅时直接以关键字搜索即可。

我主要整理了四个文档，一个是关于网络知识和网络数据分析的，一个是Linux系统相关的，一个是关于软件异常崩溃分析的，一个是日常疑难问题的场景记录与分析，四个文档加起来大概好几千页，我觉得这也是笔财富，我经常和我老婆说，说不定以后我还能出一本技术方面的书呢！当然，这都是后话了，哈哈！

同事们看到我在整理文档，说我又在整理我的葵花宝典了！这又何尝不是呢，这文档里满满的都是我的经验。公司里要求定期编写技术案例文章，做技术分享，每个团队都要出案例。同事们经常开玩笑的说，写案例对你来说太容易了，从你的葵花宝典中随便抽取一小段就能成一篇案例了。

结束语

好了，这些就是我日常工作的一部分内容，在此分享出来，希望能给大家提供一个借鉴。

最后欢迎大家留言评论，也可以和我在线交流。