最近写文档心得
最近一直在写机房收费系统的文档。提起文档,真的很头疼啊——全身头疼。做机房收费系统的感受是,一开始感觉很难,但是一开了个小头,就行如流水一般做下来了;而写文档一开始的时候感觉很好写,不就是写字吗,可是想把文档写好,起码自己看过去,真的不简单啊。
一开始很纠结究竟要怎么写文档、要写多少文档。自己看视频的时候,就将一些需要写成的文档都总结到一个单独的导图里了。等看完视频开始写文档的时候,真的好多啊……后来,不得不上网看看。在网上看到了贾林的思路。依他的导图,他应该是写了视频中所提到的所有文档。后来又看到了得鹏的博客,他应该就是写了视频中所包含的文档……
我知道文档对于我们程序员来说,非常的重要。
记得上次九期开见面会的时候,陈伟东师哥在视频里说过。他最近一直在忙的系统,文档不是很全,所以实施起来非常不方便,程序的很多地方阅读起来非常的费劲;记得师哥写过一篇博客,不是郗晓勇师哥就是纪争光师哥写的,我找了,不过没有找到,感兴趣的可以自己搜一下。他文章里提到的就是写文档的重要性,没有文档是多么的寸步难行。
其实,我最纠结的就是这里了。文档很重要,但是写不好。
看了自己之前写过的可行性分析文档、需求规格说明书文档,总感觉写的很没有逻辑,有拼凑的意思。总之很牵强。
依我的思路,跟贾林有相仿的地方。就是尽量向多里写。只要视频中提到的文档,不管怎样,都给他来一遍。
可是实施起来,真的不容易。提起了需求规格说明书,可是又着实头疼了。包括概要设计说明书和详细设计说明书,网上的文档格式跟米老师给的模版大相径庭……无语了,没办法,折中着取吧……
这几天最纠结的就是数据流图、数据字典了。这一块儿的东西,总感觉写的不伦不类的,感觉特别扭。有的东西自己写了看着都不舒服。
其实也没啥,就是感觉写文档写郁闷了,出来发泄一下。估计也到点了,该去写文档了。。。。。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
· Linux系列:如何用heaptrack跟踪.NET程序的非托管内存泄露
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构