从需求到接口文档

117 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第14天,点击查看活动详情

最近一位大佬带着我做项目,防止后面把操作忘记,在这里记录下。本身这篇文章应该在16号发布,但是因为这个项目有点复杂,我又有点菜,什么都是第一次接触。所以懵逼了,因为菜和懵逼就得多花时间,就几乎没有其余时间了。

1.需求描述(PPT)

目的:非技术角度跟客户对接(描述好讨论后的需求)相当于跟客户(乙方)的一个协议附件

要有

  1. 项目的目的(overview)
  2. 关键需求(一条条描述出来,包括界面草图)
  3. 需求列表(相当于衡量工作量大小和日后回溯)

大佬帮我写好了需求描述,CRM系统,然后后期根据进一步的方法变化也改了不少细节。一开始想的是直接做到网站上,后面想的更简单的方法就是放到小程序上,微信授权获得客户信息这样子。 具体的ppt分节是:

  1. overview
  2. 业务场景/流程(这里的主要流程才能体现你整个系统的运作过程。描述要清楚)
  3. 具体需求分析介绍,画出界面草图(直接用ppt粗略画就好了),旁边写上这个草图的流程以及介绍它。
  4. 需求列表,相当于一个表格,要有需求编号、需求优先级、需求描述、预期完成时间,最后附上整个系统/项目交付时间

2.需求分析

包括:系统设计(开发团队内部对齐需求的关键文档,包括技术化的需求描述,数据库结构设计,关键技术点设计等)接口文档(前后端的接口文档,这是指导前后端连调的重点文档)(补充说明:这次搞项目因为比较小型,且实际开发只有两个人,所以前后端各一人,但是分配好工作最重要。)