开发前建议先写个文档,嗯想法不错

一、轻文档先行

什么叫轻文档?其实轻文档指的是不需要按照标准的软件工程知识来编写需求分析,架构设计,模块设计,流程图时序图等文档,而是采用比较自由的方式,把你要做的事情,还有做事情的步骤描述清楚的文档。这样的文档不需要限制格式,甚至你可以手写在自己的笔记本上面,只要自己能看得懂,在开发过程中能够随时查阅就可以了。

1. 为什么要写文档

刚开始工作的时候,总是一接到任务就马上开始写代码,结果遇到了很多问题,例如:

①. 需求本身就存在问题,代码写到一半以后才发现

②. 部分需求没有表达清楚,发现的时候才去沟通,结果发现时间不够,或者跟之前的代码产生冲突

③. 代码写到一半时,发现自己思路不对或者不清晰了

最后很有可能导致项目延期。

如果在开发前就把需求分解好,把问题沟通清楚,把要做的点一个个列下来,就能大大地避免这些问题。

2. 文档写什么

①. 准备工作

在开始之前需要准备什么?例如做一个发送消息的界面,需要有以下的准备:

a. 接口协议

b. 测试环境

c. 测试账号

准备工作提前做好,往往会加快效率。为什么要把这些内容记录下来,是为了在开发过程中可以快速检索。如果等到开始开发以后再去查聊天记录,或者是找相关人员询问,那就慢了。

②. 罗列需要做的小功能点

例如做一个发送消息的界面,就有很多小功能点:

a. 发送界面

b. 发送的数据接口

c. 文本字数限制

如果你仔细一想,可能还会出现以下问题:

a. 是否需要登录?如果未登录,是否要引导登录

b. 对于发送失败的情况,要如何处理?

c. 字数超出限制时,如何交互?

d. 用户重复发相同的文本,是否要过滤?

e. 如何处理数据接口的错误码?

当你记录下这些小功能,并且跟产品经理沟通清楚以后,你的开发周期已经可以初步评估了,并且这时候也已经弄清楚这个需求有多少小功能,需要怎么划分模块,怎么构建内部流程。

对于部分流程复杂的功能,可以画一下流程图辅助理解

③. 记录这个需求的改动点

如果这是一个新需求,并且跟以前的版本没有任何关系,则可以忽略这部分

如果是这个需求会影响以前的代码,则需要将改动部分记录下来,因为项目中的 bug 有很多是改出来的,列出改动点后会让自己更清楚新功能带来的影响,减少很多低级bug

例如新增一个发送图片的功能,这个功能会影响聊天窗口的展示,会影响键盘,这些改动点就要记录下来。一来可以辅助思考有没有漏掉的小功能点,二来在自测试的时候需要覆盖聊天窗口的展示和键盘的切换。

④. 罗列自测试内容

编码完成以后,一定要进行自测试,自测试越仔细,越能提前发现 bug 并修复。如果是测试人员发现了 bug ,然后再提交给你,你这时候再去解决,效率往往会比较低。

以发送消息为例,自测内容也有很多:

a. 正常发送消息

b. 未登录时点击发送

c. 字数超出限制

d. 没有网络时点发送

e. 网络很差时不断点发送

等等.......

二、开始编码

1. 是重写还是保持不变

每做一个新需求,都有可能会面临这样的问题:

①. 以前的模块写得太烂了,很想重新写

②. 差不多的需求,以前用了这样的方式实现,这次想换一种方式实现

会考虑以上的问题,证明你是一个想要不断进步的人,但是,在做决定之前最好先考虑以下因素:

①. 重写模块,很可能牵一发而动全身,要想清楚改动可能带来的影响,以及解决这些问题需要的时间

②. 使用新方案实现需求,新的方案是否已经经过仔细的验证,如果没有,它可能会带来新问题

其实保持不变也有一些优势:

①. 可以比之前做得更快,因为你熟悉了

②. 不会出现新问题

考虑好以后,是重写还是保持现状,基本已经有答案了

不过保持现状并不意味着是放弃追求,你可以用业余的时间来证明你的方案,当它已经稳定了,可行了,那你随时都可以重写了。

2. 实现需求,Demo 先行

用 Demo 来实现一个需求是最快的,因为它运行快,可以随意修改,而且代码量少,如果实现过程出现问题,很容易就可以定位到原因。

先建立一个 Demo,然后把需要的资源移植过来,把功能实现以后,再移植到项目中,这样可以节省不少开发时间

3. 借助工具

①. 代码模板(File Template)

我们创建一个视图,控制器,或者一个 Model,可能会有一些固定不变的函数、属性需要被定义或者重写,使用 Xcode 可以创建代码模板,在创建类文件的时候一键生成这些代码,提高效率。

②. 代码片段(Code Snippet)

一般可重用的代码,我们会封装成类或者函数,以便其他地方使用,但有一些代码是不适合封装的,例如:

a. 声明一个属性

b. 创建一个线程

像这类的代码,我会做成代码片段,然后通过 Xcode 的 Code Snippet 自动补充功能来快速完成,一个代码片段例子:

这里写图片描述

只要输入 @OperateThread 就可以直接完成创建一个操作队列的代码,大幅度减少编码时间。

③. 自动注释工具(VVDocumenter)

一个可以一键创建注释模板的工具,减少写注释所需的时间

4. 适当添加注释

如果像官方的 API 那样,所有地方都添加注释,那工作量就太大了,需要额外的开发时间,如果只是针对一些语义不明、有歧义的代码添加注释,反而会减少开发时间。

例如一个属性:

@property (nonatomic, assign) int64_t createTime;

一看就知道是指创建时间,但它到底是不是时间戳?如果是时间戳,那单位是秒还是毫秒?如果还要打印数据以后才能下结论,就太耗时间了。

加上注释以后,它就一目了然了

/// 创建时间(时间戳 秒)

@property (nonatomic, assign) int64_t createTime;

三、自测

1. 先检查后自测

完成一个小功能以后,先检查一下代码,然后再开始自测,因为代码可以告诉你很多信息:

①. 是否有低级错误

②. 是否有难以发现的漏洞

③. 流程是否存在问题

如果你编码完成以后立即自测,可能会进入被动状态:

①. 这个界面显示不对

②. 这个数据跟预期对不上

③. 有些不该出现的东西出现了

这时候再反过来去调试代码,一步步修改,会很慢,因为你编译和操作都需要时间,而且有些条件不是很容易模拟,那种情况就更耗时间了

2. 自测点要全部过一遍

可能你会觉得这很烦,很浪费程序员的时间,但自测过程发现 bug 是最容易修复的,因为这时候代码记忆最清晰,最容易找到问题所在。

四、总结

先用文档理清思路,然后开始编码,编码完成以后要检查代码并自测。这就是我的编程习惯,一直沿用至今。

其实知道一个技巧,并不会提升效率,只有坚持使用这个技巧,并形成习惯以后,才会真正地提高效率。

时间: 2024-08-26 08:46:05

开发前建议先写个文档,嗯想法不错的相关文章

开发API完成,写个文档

Jira对接Prism开发API指南 部门 证系统运维团队 文档制作人 陈刚() 时间 2017-04-05 版本 第一版 目录 目的... 1 通例:... 1 认证... 2 新建版本单... 2 获取指定版本单的发布单信息... 3   目的 为了提升工作效率,打通jira和prism之间的联系,让软件项目管理人员可以在jira上新建版本单,并跟踪发布进度,特在prism上制作相关API供jira调用. 通例: l  Prism的web址会因环境不同或构架变更而发生变更,jira端须提供自

让你提前认识软件开发(40):既要写好代码,又要写好文档

第3部分 软件研发工作总结 既要写好代码,又要写好文档 对于软件相关行业,在学校或单位上,大家也许都已经注意到了,除了要编写的程序.绘制设计图之外,还有一个重要的工作便是写文档.为什么要写文档呢?因为我们要把自己做的东西展示出来,不光展示给同行看,可能还要展示给其他岗位上的工作人员看,甚至展示给用户看.如果我们只是会写程序,不会在文档中描述自己的想法,那么就真正的成为"码农"了. 工作也有一段时间了,我发现周围的同事,会写高质量文档的确实很少.李开复老师在<浪潮之巅>的序言

为什么要写设计文档

日趋一日,程序员能够在更少的时间内完成更多的事情.使用今日的高级编程语言,开发环境,工具和“快速应用开发”思想,程序员和经理都已经习惯于急速的开发周期.今日的程序员更倾向于直接跳入到编码之中,害怕花费在非编码工作中的每一小时,都会导致项目截止日期前的周末多加一个小时班. 编码之前做设计这一过程已经变得过时了,将设计文档化就更罕见了.很多程序员从来没有写过设计文档,面对要写设计文档这一想法都畏缩不前.即使被要求写,通常来说也只是产出了一大堆的交互图和类图,这些图表大多没有表达程序员在设计阶段的思考

小白如何写需求文档

上学期在跟着网站里的学长学姐学了许多东西,假期我们需要自己做一套网站签到OA出来,昨天刚刚把需求文档定下,万事开头难,我把迈出的第一步记录下来,也给第一次写文档的小伙伴一些建议. 第 一次写,难免无从下手,在网上查找了大量的需求文档范例,网上也有模板,不过模板上东西很多,有些我还并不太了解,也不太适用于自己我们要做的OA. 既然是需求文档,那就应该根据项目实际情况去写文档,所以我们在写文档时注重的是我们需不需要,而非和模板是否符合.接下来,是我们写文档的步骤. 1.定框架 首先要把整篇文档需要的

程序员要双管齐下写好代码和写好文档

有一个问题就是程序员为什么不喜欢写文档,这个问题是一直存在的,不管怎么说,文档绝对是程序员最大的软肋.一些被称之为高手的程序员,往往是文档方面的低能儿.不管这个程序员是在大公司.还在小公司.不管程序是写文档的.还是不写文档的,大部分程序员在内心深处中是不愿意写文档的.  天下的怪事特别多,有时让人不能理解.程序员一般不愿意写文档,但是程序员却喜欢看别人的文档.即使写了文档,程序员一般不会把所有功能都写入文档,却抱怨别人文档有的功能没有说明.即使写了某段文档,程序员一般不不想把文档写的很详细,却抱

告别手写接口文档时代,比Swagger功能更强大的LKADocument接口文档管理框架诞生了!

更详细的更全面的教程请观看作者亲自录制的视频教程,地址: https://edu.51cto.com/sd/9cb7fLKADocument视频教程 一.介绍 在前后端分离,分工更加明细化的今天,为了减少前端和后台开发人员的沟通成本,能够让他们做到并行开发,同时也能保证前端和后端开发人员所看到的接口文档的一致性,即时性,以此来大大提高工作效率.所以出现了一些非常优秀的接口管理工具,具有代表性的像Swagger,因为它能够通过注解或yml和JSON描述文件来自动生成接口文档.但是我觉得它不管是在配

C#写TXT文档

//C#写TXT文档 String strDir = System.IO.Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().GetName().CodeBase); string filePath = strDir + "\\putin.txt"; FileStream fs = new FileStream(filePath, FileMode.Append); StreamWriter s

AppleWatch开发教程之调试程序使用帮助文档

AppleWatch开发教程之调试程序使用帮助文档 AppleWatch开发教程之调试程序 调试又被称为排错,是发现和减少程序错误的一个过程.在Xcode中进行调试的需要实现以下几个步骤: 1.添加断点 在进行程序调试之前,首先需要为程序添加断点,断点是调试器应该停止程序的运行并让开发者可以运来查看成的地方.将光标移到到要添加断点的地方,按住Command+\键或者选择菜单栏中的"Degbug|Breakpoints|Add Breakpoint at Current Line"命令进

使用docsify 写开源文档

使用docsify 写开源文档 官网:https://docsify.js.org/#/ docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件"污染" commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages. 一.初始化