略谈为什么要重视文档写作

简介: 略谈为什么要重视文档写作

一、背景

 

今天在知乎上看到一篇《作为IT行业过来人,你有什么话想对后辈说的?》问题的答案,其中一小段摘录如下:

image.gif

非常值得在这里给大家分享一下。

二、感悟

2.1 亲身体会

见过很多刚毕业的同学缺乏工作经验又急于表现,为了尽快做完项目,在没有了解清楚相关背景和价值,没有做好完整的技术方案时,就着急开始编码。导致很多项目后面会有推倒重来的情况,也没有充分自测的意识,导致项目质量也不是很高。

这或许就是所谓的“欲速则不达”吧。

2.2 重视设计

这里所说的写文档更准确说应该是编写技术方案文档。

在技术方案文档中,将业务逻辑梳理清楚,设计好核心功能的技术实现,梳理好依赖的接口,画清楚系统之间、接口之间的调用关系,考虑清楚各种异常场景等。

然后对技术方案进行评审,让其他经验丰富或者了解该块业务的同事提提建议,对方案进行优化。

当技术方案设计清楚并评审通过,然后再编码,心里就会非常有底。

方案设计合理,编码只是一个时间问题。

如果编码完成后能进行充分自测,并进行代码评审,那么项目质量应该不会出现大问题。

2.3 百分比问题

文中提到,设计应该花 80% 的时间,编码和调试应该花 20% 的时间。

我不是特别认同这个百分比,实际工作中,比如10天编码的项目,可能要2-3天熟悉需求,然后进行技术方案设计。

如果把这个百分比当做是重要性我道是更倾向于认同。

大家要抓住重点,文章想表达的是技术方案设计的重要性。

三、总结

本文虽然内容不多,但在此呼吁大家在动手之前一定将核心的逻辑,核心的方案想清楚,尽可能落到文档中。

在项目编码完成之后,一定要自己先自测,自己先审查一下自己的代码,然后再提测。

在提测期间,强烈推荐通过 tail -f  error.log  或者其他方式随时观察错误日志,项目相关问题早点修复掉,而不是等测试找到你再去改。

这种意识非常重要,希望刚工作不久的同学一定要重视。

PS: 改天有时间我会写一下如何写技术方案,如何写提测文档。


相关文章
|
存储 安全 算法
Qt QStack 详解:从底层原理到高级用法
Qt QStack 详解:从底层原理到高级用法
418 0
|
存储 算法 程序员
STL1(C++标准模板库)
STL1(C++标准模板库)
103 0
|
自然语言处理 运维 Linux
开发者评测|操作系统智能助手OS Copilot
OS Copilot是阿里巴巴云开发的Linux操作系统智能助手,专为提高Alibaba Cloud Linux使用效率设计。它支持自然语言问答、辅助命令执行、系统运维和调优,尤其适合新手用户。OS Copilot能学习用户习惯,提供专业操作系统问题解答,简化命令行操作,并集成阿里云CLI。用户可以通过命令行与之交互,执行命令,调用阿里云服务,进行系统维护。
|
存储 搜索推荐 C语言
运用指针轻松实现多个数据排列
这段内容介绍了一种使用PLC编程进行数据排序的方法,特别是通过冒泡排序算法来实现。文中以一个包含5个数字(90, 21, 132, -58, 34)的序列为例,详细解释了排序过程,包括多轮比较和数据交换。在每一轮中,最大的数字会移动到右侧。通过嵌套的FOR循环结构实现程序逻辑,其中外层循环控制轮次,内层循环处理每轮的比较和交换。最终,程序能够将序列从小到大排序。
101 6
|
算法 Java C++
蓝桥杯 算法训练 小生物的逃逸(球坐标公式+暴力求解)
蓝桥杯 算法训练 小生物的逃逸(球坐标公式+暴力求解)
|
机器学习/深度学习 人工智能 自然语言处理
探索AIGC的无限想象力
前言:人工智能生成内容(AIGC)作为当下最热门的话题之一,正引领着创作领域的革新和变革。AIGC通过人工智能技术的应用,实现了内容的自动生成和创作,开启了一种全新的生产方式。在2022年被誉为AIGC元年,新一代的AIGC模型不仅可以处理丰富多样的模态,还能跨模态产出,例如AI插画和文字生成配套视频等。阿里云开发者社区在此推出“5月AIGC挑战赛”,邀请您一同畅聊AIGC,分享技术解读、演进趋势和未来的畅想。
452 0
|
存储 算法 API
基于单片机的无线语音遥控智能车设计
基于单片机的无线语音遥控智能车设计
403 0
基于单片机的无线语音遥控智能车设计
|
网络协议 测试技术 Go
海量用户通讯系统-服务器接收消息1
海量用户通讯系统-服务器接收消息1
海量用户通讯系统-服务器接收消息1
在vuecli3怎么压缩代码以及打包怎么去除console.log?
在vuecli3怎么压缩代码以及打包怎么去除console.log?
166 0