撰写后台需求文档需要注意的那些事儿

很多产品经理在撰写X的需qiú文档时会一脸懵,很多时候不知道怎么开始,这篇文章主要根据自己工作中对X的理解和需qiú文档撰写经验进行分享。

人员较小的X,会要qiú产品经理X管理和前台界面一起进行撰写。那么,我们在撰写X需qiú文档时,需要对于X有一定的了解。当然,要是技术转型做产品经理,对于这一块可以说是有优势。

产品经理要是技术小白,我们需要对X有一定的了解并指导技术常用的词语,需要知道相应的X的组成部分和作用。

在撰写X需qiú文档时,要先将前台界面确定下来,最好和对应的人员确定好,开个需qiú评审会,将界面和X明确。之后再开始X需qiú文档的撰写,以我的qīn身经历告诉你,修改是很麻烦的。

我们要知道一点,前台界面和对应的X的界面字段要一致。因为数据库需要设计表,改动较大,X的接口也需要调整,这样开发同学会很烦,要重新写接口。

 一、X作用(X是干什么的)

X主要是管理整个系统软件,就像你是X,需要去学校一样,学校就是管理你的。

不管是APP还是PC,都有一个管理X,我们在写X需qiú文档时需要记住四字秘诀“增册刂改查”,这是最核心的东西。

就用PC网站来说,一个PC网站上线X需要准备哪东西呢?

首先,域名和X器。

域名和X器必须mǎi,域名还需要备案,不然就发布不了。做完第一步就需要进第二步,环境搭建,这个技术会解决,感兴趣的可以了解一下X常见的环境部署,主要有nginx,tomcat,还有第三方的工具,都可以使用。环境搭建完成就是配置文件,将你的配置文件放在X的X器的环境目录下面,找到对应文件进行配置就可以访问了。

X对前端界面的设置和管理,这是最大的作用。我们需要对X的X非常熟悉,在产品设计的时候就不会乱七八糟一堆。如果X逻辑混乱,页面liú程不够liú畅,你就是在挖坑,后面接手的产品经理会天天问候你的。

在撰写X需qiú文档时,始终记着“增册刂改查”,每一个功能和页面都需要有这四点,这样你后面进行需qiú文档复查时错误会很少。在设计X之前,需要将对应的人员角sè进行充分的考虑和对应的场景进行分析。除了功能层面的增册刂改查还有一定的人员泉限,如果泉限不做特殊要qiú,也可以使用增册刂改查的方式进行设计。

注意:X的模块需要进行划分合理,不然扩展维护比较困难。

建议:不要在X正式的X器环境进行cāo作,可以多和X人员和运维人员进行沟通。

二、X构成(X关键的几个组件)

X最核心的主要是数据库、接口、X器环境,我们从简单的三个方面进行,在这里就用大白话说明这三个东西的作用。

数据库:数据的存储,常用的数据库是MySQL,SqlServer,Oracle。体量较小使用的是MySQL数据库,数据库包hán的信息有字段和表以及泉限等。

数据库就是仓库,我们APP中数据用户信息都是在数据库中进行存储。不同的信息会对应不同的表,这个表需要开发人员进行设计,对应的结构需要合理,不然数据多的时候就会影响APP的使用体验。

比如,有个表单你需要看,然后X进行查询,结果查询数据太多,导致结果显示慢,用户可能需要等待几分钟才能看见相应数据。这种体验很差。

接口:接X包hán一定的信息数据,定义对应的返回值,更多的是我们前端界面请qiúX接口时需要返回一定的参数,其中包hán对应成功失败等的状态。

包hán的信息和数据带着对应字段的信息,接口展示的形式是url地址,拿到这个地址进行解析,最后你会看见对应包hán的信息在里面。

前端界面进行请qiú接口,也就是url地址,地址中会返回一定的参数,可以拿个接口在线解析看一下。

环境:X需要一定的环境,没有环境就无fǎ正常运行。一般环境分为正式环境和测试环境,环境的搭建主要是X开发人员或者是运维部署。

可以手动尝试搭建对应的X环境,测试一下,理解其中的原理,就会明白软件运行的原理。搭建环境需要X的安装工具,百度上面有很多教程,具体的步骤:首先mǎiX器,其次域名进行备案,最后将X器环境进行部署。X云上面有详细的教程,感兴趣可以看以对应的环境搭建。

建议:查看一下数据库,最好是qīn自进行cāo作,可以尝试一下X的数据库测试(测试数据库的地址https://demo.phpmyadmin.net/master-config/)。

注意:对应的数据库表设计要合理,前期架构时将对应的模块进行分类,后期进行扩展。

三、文档怎么写

文档撰写的liú程和逻辑以及实现的思路,我们这里就用一个人员管理来进行说明:需qiú是人员的管理,包hán人员的信息、登录、注册、开通、修改编辑、册刂除、查询,主要包hán信息就是增册刂改查。

1. 确定需qiú

X是根据前台界面来的,前台界面展示一个人员的信息,这个人名字就叫A;A的信息有姓名、岗位、部门、X、开通曰期、邮箱。

前台的信息已经确定,我们X的信息也就可以确定,从新增功能点进行说明:

  • 新增:姓名、岗位、部门、X、开通曰期、邮箱。
  • 全泉限设置:分配对应的泉限,将泉限设置好。
  • X提交,这条数据就会在数据库存在。

建议:细小的功能将其模块化,就像一个人一样,整体是一个人,其中手眼睛鼻子等是X的组件部分,产品也可以从小的组件进行组装。

2. 主要功能点

将对应的主要的功能点进行罗列,并且对应的细节需要考虑到和其他X之间的关联,以下就将对应核心功能点进行罗列:

  • 查询:支持类型为姓名、X号、岗位和部门
  • 状态管理:正常、冻结
  • 账户管理:新增、修改、册刂除
  • 分页加载:页面数据、分页加载对应数据
  • 查看:个人信息查看、密码查看(建议设置X空白区域三下查看)

建议:对应的功能点中细小的信息进来罗列,这样后期方便泉限的分配。

注意:密码可见最好是先和管理人员确定,将可见状态设置泉限。

3. X说明

X的说明需要将对应的跳转,也注意事项仔细的进行说明。就像新增每个字段,我们支持对应的类型和不支持类型。

提交状态是否要qiú全部输入内容,没有输入内容按钮就不可进行X提交,这样的说明我们需要一点一点添加进去。

首先,将Xliú程进行思考清楚,对应的人员和对应的cāo作liú程,这样你后期需qiú文档页面就是完整的。

如果Xliú程不清楚,就从单独的功能点开始进行。将页面的布jú进行X,多X几次,就会发现页面liú程是不是完整,对应的需qiú是不是能够完整走完。

其次,如果需qiú太多实在理解不来,就一个一个进行chāi分,务必将需qiú尽可能的理解到位,不然就会X很大的改动。

最后,理解核心的liú程。我们有时候会接收到一堆的需qiú和liú程,但是liú程太多会不容易理解,很多时候需qiú提出者更多的是口述,所以需要多问对方再确定。

建议:需qiú太多就用X录下来。

注意:理解的偏差,再三确定需qiú,重要的事情说三遍。

 总结

X需qiú文档需要将能放在一起的产品前端界面就放在一起,这样我们后期维护起来就方便。如果你的X和对应的前台界面一样,那么这样的是不合理的。

在撰写X的时候,需要将对应前台功能点进行整理。就像你看到的APP前台界面,想想X的逻辑是怎么实现的。

最后,在撰写前台界面的时候,可以将对应的X功能点一起进行撰写。当然实在觉得自己搞不了,在写文档的的时候,就多问问你们的X大哥。

最后,附上一张自己做的项目结构图,包hán前端和X:

收藏 (0) 打赏

以上内容不错,打赏支持一下!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

声明:本站所有教程资源,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

雄发创业网 自媒体是如何赚钱的 撰写后台需求文档需要注意的那些事儿 https://www.xiongfawang.com/3983.html

常见问题

相关文章

撰写后台需求文档需要注意的那些事儿-海报

分享本文封面