AI+软件工程:10倍提效!用ChatGPT编写系统功能文档

系统功能文档是一种描述软件系统功能和操作方式的文档。它让开发团队、测试人员、项目管理者、客户和最终用户对系统行为有清晰、全面的了解。

通过ChatGPT,我们能让编写系统功能文档的效率提升10倍以上。

用ChatGPT生成系统功能文档

我们以线上商城系统为例,介绍如何使用ChatGPT帮我们完成系统功能文档编写。

向ChatGPT发送如下请求:

角色:系统功能文档撰写专家

背景:

系统功能文档撰写

注意事项:

编写高质量的系统功能文档,是确保项目成功的关键步骤。

技能:

  • 熟练运用各类文档组织格式。

  • 善于从客户视角考虑需求。

  • 能够捕捉用户需求,将其转化为明确的功能要求。

  • 精通系统功能的业务与技术细节。

  • 具备逻辑思维,能够编写合理的实现逻辑和功能细节描述。

目标:

  • 设计一个规范的系统功能文档框架,确保每个功能需求都得到明确描述。

  • 在文档中包含功能名、需求描述、概述、功能细节描述。

工作流程:

  1. 首先,用话术引导用户输入系统需求描述,理解用户的期望和项目目标。

  2. 设计一个明确的系统功能文档框架,包含功能名、需求描述、概述、功能细节描述。

输出格式:

  • 功能名:[功能名]

  • 需求描述:[需求描述]

  • 概述:[概述]

  • 功能细节描述:[功能细节描述]

初始化

简介自己, 引导用户输入对系统的需求描述,全程使用中文描述。

ChatGPT回答如下:

您好!作为系统功能文档撰写专家,我在这里帮助您把系统需求转化为清晰、详尽的文档,确保项目成功实施。我将运用我的专业技能,从客户的视角出发,精准捕捉需求,并将其转化为明确的功能要求,同时确保文档的高质量和易于理解。

请您描述一下您希望实现的系统需求,包括您希望通过这个系统解决的问题、期望实现的功能等。这样我可以更好地理解您的项目目标,并为您设计一个规范的系统功能文档框架。

向ChatGPT发送如下请求:

我们要开发一个线上商城系统,需求如下: - C端功能包括:品牌首页、基于LBS进店、加购、订单列表、结算、下单、支付、个人中心。 - B端功能包括:组织管理、渠道管理、客户管理、店铺装修、商品管理、B端管理、库存管理、订单管理、营销管理、配送管理、数据分析。 帮我生成一份详细的系统功能文档。

ChatGPT回答如下:

C端功能需求文档

1. 功能名:品牌首页

- 需求描述:为用户提供品牌介绍、主打商品展示、活动宣传等信息的入口页面。

- 概述:首页需要具有吸引用户并提供品牌信息的设计,包含搜索、分类浏览等功能,优化用户的访问体验。

- 功能细节描述:实现轮播图广告、热门商品推荐、品牌故事介绍等模块。支持用户搜索商品、查看各类商品分类。

2. 功能名:基于LBS的进店

- 需求描述:允许用户根据地理位置信息选择最近的店铺进行浏览和购买。

- 概述:通过LBS技术,推荐用户周围的店铺,提升用户体验和购买转化率。

- 功能细节描述:获取用户授权的位置信息,展示用户当前位置附近的店铺列表,支持店铺搜索和选择。

3. 功能名:加购

- 需求描述:用户可以将心仪的商品添加到购物车中。

- 概述:为用户提供便捷的商品浏览和加购体验,支持多商品加购和购物车管理。

- 功能细节描述:实现加购按钮、购物车商品数量编辑、购物车列表展示、商品选中结算等功能。

4. 功能名:订单列表

- 需求描述:允许用户查看其所有订单的状态和详情。

- 概述:提供一个用户友好的界面,展示用户的订单历史,包括正在进行、已完成、已取消等状态的订单。

- 功能细节描述:实现订单筛选功能,支持按照订单状态、下单时间等条件筛选。每个订单项需显示订单号、下单时间、商品详情、订单状态、支付金额等信息。

5. 功能名:结算

- 需求描述:用户在购物车选择商品后,进行订单确认和支付前的最后一步操作。

- 概述:为用户提供一个清晰的结算页面,展示所购商品详情、价格、预计配送时间等信息,并允许用户选择支付方式。

- 功能细节描述:包括商品列表、数量选择、价格汇总、优惠券使用、收货地址选择、支付方式选择等功能。

6. 功能名:下单

- 需求描述:用户完成商品选择和支付信息填写后,创建订单。

- 概述:确保用户能够轻松地完成订单创建,包括核对订单信息、选择配送选项、确认支付等步骤。

- 功能细节描述:生成订单摘要,包括商品详情、订单总额、支付信息、配送信息。支持不同的支付方式,包括但不限于信用卡、支付宝、微信支付等。

7. 功能名:支付

- 需求描述:为用户提供多种支付方式,完成订单支付。

- 概述:实现安全、便捷的支付流程,确保用户信息安全。

- 功能细节描述:集成第三方支付平台,支持支付状态查询和回调处理,确保支付成功后更新订单状态。

8. 功能名:个人中心

- 需求描述:允许用户管理个人信息、查看订单历史、管理收货地址等。

- 概述:提供一个个性化的用户界面,方便用户访问和管理个人相关信息。

- 功能细节描述:实现个人信息编辑、密码修改、订单历史查看、收货地址管理、支付方式管理等功能。

B端功能需求文档

1. 功能名:组织管理

- 需求描述:允许商城管理员配置和管理组织结构,包括部门、员工角色等。

- 概述:提供一个界面让管理员能够方便地管理公司的组织架构。

- 功能细节描述:实现组织架构的创建、编辑、删除功能;员工的添加、角色分配、权限设置等功能。

2. 功能名:渠道管理

- 需求描述:管理销售渠道和合作伙伴信息。

- 概述:为商城提供渠道拓展和渠道维护的管理功能。

- 功能细节描述:实现渠道信息录入、编辑、渠道业绩追踪、合作伙伴管理等功能。

3. 功能名:客户管理

- 需求描述:允许企业用户管理其客户信息,包括客户资料的录入、编辑和查询。

- 概述:为B端用户提供一个完整的客户信息管理系统,增强客户关系管理能力。

- 功能细节描述:客户信息的录入、编辑、删除功能;支持按照客户名、联系方式等条件搜索客户;客户购买历史和偏好分析等。

4. 功能名:店铺装修

- 需求描述:允许B端用户自定义店铺的布局和样式。

- 概述:提供一套灵活的店铺装修工具,支持拖拽布局、模板选择等功能,无需编程知识。

- 功能细节描述:支持多种布局模板选择,自定义颜色方案、字体选择;轮播图、商品展示区、促销活动板块等可自定义编辑。

5. 功能名:商品管理

- 需求描述:允许B端用户添加、编辑和管理销售的商品。

- 概述:提供一个界面以支持商品信息的完整管理,包括商品详情、价格、库存、分类等。

- 功能细节描述:实现商品信息的添加、编辑、删除功能;支持商品分类管理;实现库存管理功能,包括库存数量的调整和库存预警;支持商品图片上传和编辑。

6. 功能名:库存管理

- 需求描述:为B端用户提供库存量的监控和管理功能。

- 概述:确保用户可以实时了解商品库存情况,及时补充库存,避免缺货。

- 功能细节描述:展示各商品的当前库存量;支持库存的手动调整;实现库存预警设置,当库存低于预设阈值时自动提醒用户。

7. 功能名:订单管理

- 需求描述:允许B端用户查看、处理和管理客户订单。

- 概述:为用户提供订单的详细列表,包括订单状态、支付情况、配送信息等。

- 功能细节描述:实现订单详情查看,包括商品信息、订单金额、客户信息等;支持订单状态管理,如确认订单、取消订单、退货处理等;集成配送管理功能,包括配送方式选择、配送状态跟踪。

8. 功能名:营销管理

- 需求描述:为B端用户提供营销活动的创建、管理和分析工具。

- 概述:支持多种营销活动类型,如折扣、优惠券、积分奖励等,以提升销售额和客户粘性。

- 功能细节描述:实现营销活动的创建和设置,包括活动类型、时间、适用商品等;提供营销效果分析,如参与度、销售提升等指标的跟踪评估。

9. 功能名:配送管理

- 需求描述:允许B端用户管理商品的配送方式和配送状态。

- 概述:提供一个界面以支持对订单的配送方式选择、配送进度跟踪和管理。

- 功能细节描述:支持配送方式的设置和选择,如快递、自提等;实现配送进度的实时跟踪和更新;支持与第三方物流平台的集成,自动化配送流程。

10. 功能名:数据分析

- 需求描述:为B端用户提供销售数据和客户行为分析。

- 概述:通过数据分析帮助用户了解业务表现,指导决策。

- 功能细节描述:实现销售数据的汇总和分析,包括销售额、订单量、热销商品等;客户行为分析,如购买习惯、偏好分析等;支持自定义报表功能,便于用户根据需要生成各种分析报告。

通过ChatGPT,我们能生成详细的系统功能文档。基于这个,我们可以进一步修改和调整,极大地提高了写文档的效率。

用ChatGPT生成用例图

用例图是统一建模语言(UML)的一部分,用于描述系统的功能以及与之交互的外部实体(如人、系统或设备)。

它是一种图形表示法,用于展示系统的行为,通过展示参与者(actors)与系统的用例(use cases)之间的关系来实现。

用例图主要用于找出功能需求,并帮助团队理解系统提供的功能。用例图的主要元素包括:

用例(Use Cases):表示系统的一项功能或者一组功能,通常用椭圆形来表示。用例是从用户的角度出发,描述了用户可以通过系统完成的一个任务或者目标。

参与者(Actors):表示与系统交互的外部实体,可以是人、系统或设备。参与者通过与用例的交互来完成某些目标。

关系(Relationships):用来描述参与者与用例之间的交互关系,以及用例之间的关系。主要有以下几种类型:

  • 关联(Association):直接连接参与者和用例,表示参与者参与用例的交互。

  • 包含(Include):表示一个用例的执行包含另一个用例的执行。

  • 扩展(Extend):表示一个用例的执行可能扩展或增加另一个用例的行为。

  • 泛化(Generalization):表示参与者或用例之间的继承关系。

用例图主要用于需求分析阶段,帮助项目团队和客户之间建立共同的理解,以确保软件完全满足用户需求。它为开发过程提供了一个清晰的功能视图,同时也是沟通、讨论和计划的基础。

ChatGPT与PlantUML结合后,可以生成各种UML图表。接下来,我们使用ChatGPT生PlantUML语言描述的用例图。

向ChatGPT发送如下请求:

上文中已确定线上商城系统功能,请使用PlantUML语言帮我绘制用例图。

ChatGPT回答如下:

@startuml

left to right direction

skinparam packageStyle rectangle

actor C端用户 as cuser

actor B端用户 as buser

rectangle C端功能 {

(品牌首页) as (HomePage)

(基于LBS进店) as (LBSStore)

(加购) as (AddToCart)

(订单列表) as (OrderList)

(结算) as (Checkout)

(下单) as (PlaceOrder)

(支付) as (Payment)

(个人中心) as (UserProfile)

}

rectangle B端功能 {

(组织管理) as (OrgManagement)

(渠道管理) as (ChannelManagement)

(客户管理) as (CustomerManagement)

(店铺装修) as (StoreDecoration)

(商品管理) as (ProductManagement)

(B端管理) as (BManagement)

(库存管理) as (InventoryManagement)

(订单管理) as (OrderManagementB)

(营销管理) as (MarketingManagement)

(配送管理) as (DistributionManagement)

(数据分析) as (DataAnalysis)

}

cuser --> HomePage : 浏览

cuser --> LBSStore : 定位与推荐

cuser --> AddToCart : 添加商品

cuser --> OrderList : 查看订单

cuser --> Checkout : 进行结算

cuser --> PlaceOrder : 下单

cuser --> Payment : 支付

cuser --> UserProfile : 管理个人信息

buser --> OrgManagement : 组织架构管理

buser --> ChannelManagement : 渠道策略管理

buser --> CustomerManagement : 客户信息管理

buser --> StoreDecoration : 装修店铺

buser --> ProductManagement : 管理商品

buser --> BManagement : 管理B端用户

buser --> InventoryManagement : 监控库存

buser --> OrderManagementB : 处理订单

buser --> MarketingManagement : 执行营销活动

buser --> DistributionManagement : 管理配送

buser --> DataAnalysis : 进行数据分析

@enduml

用drawio绘制用例图

接下来,我们要使用drawio神器,绘制用例图。登录Flowchart Maker & Online Diagram Software,点击➕,选择高级→PlantUML。

将上文中的PlantUML代码,贴入文本框,点击插入。

线上商城系统的用例图就自动绘制好啦,是不是效率提升非常多~

文章转载自:架构师汤师爷

原文链接:https://www.cnblogs.com/tangshiye/p/18093747

体验地址:引迈 - JNPF快速开发平台_低代码开发平台_零代码开发平台_流程设计器_表单引擎_工作流引擎_软件架构

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/288419.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

jetcache 2级缓存模式实现批量清除

需求 希望能够实现清理指定对象缓存的方法,例如缓存了User表,当User表巨大时,通过id全量去清理不现实,耗费资源也巨大。因此需要能够支持清理指定本地和远程缓存的批量方法。 分析 查看jetcache生成的cache接口,并没…

Java设计模式 | 抽象工厂模式

抽象工厂模式 工厂方法模式中考虑的是一类产品的生产,如幼儿园只培养小朋友,鞋厂只生产鞋子。这些工厂只生产同种类产品,同种类产品称为同等级产品,即工厂方法模式只考虑生产同等级的产品,但是在现实生活中许多工厂都…

有什么代理IP推荐?如何分辨代理IP类型?

跨境外贸是近几年来的热门行业,在众多助力跨境出海的工具中,代理IP也是强力的一大保障。不仅可以帮助企业拓展更大的地区市场,更加顺畅进行市场调查,更重要地,在TikTok、Amazon、Ebay、Instagram、Etsy等等跨境平台业务…

介绍一下Redis的集群模式?

Redis有三种主要的集群模式,用于在分布式环境中实现高可用性和数据复制。这些集群模式分别是:主从复制(Master-Slave Replication)、哨兵模式(Sentinel)和Redis Cluster模式。 一、问题解析 主从模式 主从…

学点儿数据库_Day11_多表、等值连接、内连接、模糊查找

1 多表 学生表、班级表、课程表、班级课程表 关系型数据库: MySql、SqlServer、Oracle 相同的数据出现多次绝不是一件好事,这是关系数据库设计的基础。关系表的设计就是要把信息分解成多个表,一个数据一个表,各表通过某些共同的…

OpenCV模块熟悉:点云处理相关

1. 显示--VIZ 曾经基于PCL 做过不少点云相关的开发,采样VTK进行有点云显示。后来基于OpenCV做了不少三维重建工作,总是将点云保存下来,然后借助CloudCompare等查看结果。如果能够将VIZ编译进来,预计会提升开发速度。 …

86.分隔链表

给你一个链表的头节点 head 和一个特定值 x ,请你对链表进行分隔,使得所有 小于 x 的节点都出现在 大于或等于 x 的节点之前。 你应当 保留 两个分区中每个节点的初始相对位置。 示例 1: ​ 输入:head [1,4,3,2,5,2], x 3 输出&…

unity学习(70)——编译游戏发生错误2

1.全屏问题其实无所谓,windows用tab可以切出来的。 2.现在主要问题是服务器try了以后虽然不崩溃了,但不再显示2个实例对象了,unity和exe此时都只能看到一个实例对象 2.1把之前报错位置的try-catch先注释掉 2.2 unity中此时登录666账号&…

Git工具的详细使用

一、环境说明 [rootgit ~]# getenforce Disabled [rootgit ~]# systemctl status firewalld ● firewalld.service - firewalld - dynamic firewall daemonLoaded: loaded (/usr/lib/systemd/system/firewalld.service; disabled; vendor preset: enabled)Active: inactive (d…

Avalonia笔记2 -数据集合类控件

学习笔记&#xff1a; 1. DataGrid 笔记1中已经记录&#xff1b; 2. ItemsControl 属性&#xff1a; ItemsSource&#xff1a;数据源 ItemsControl.ItemTemplate&#xff1a;单项数据模板&#xff0c;内部使用<DataTemplate> 示例&#xff1a; <ItemsContr…

docker关闭全部运行容器命令是什么?

环境&#xff1a; docker v22.1 问题描述&#xff1a; docker关闭全部运行容器命令是什么&#xff1f; 解决方案&#xff1a; 要关闭所有正在运行的Docker容器&#xff0c;可以使用如下命令&#xff1a; docker stop $(docker ps -a -q)这条命令首先执行 docker ps -a -q…

35.HarmonyOS App(ArkUI)使用父组件@Builder装饰的方法初始化子组件@BuilderParam报错

HarmonyOS App(ArkUI)使用父组件Builder装饰的方法初始化子组件BuilderParam报错 Type void is not assignable to type () > void. <tsCheck> 去掉括号()就可以了 装饰器&#xff1a; 用于装饰类、结构、方法以及变量&#xff0c;并赋予其特殊的含义。如上述示例中En…

使用LangChain LCEL生成RAG应用、使用LangChain TruLens对抗RAG幻觉

# 导入LangChain的库 from langchain import *# 加载数据源 loader WebBaseLoader() doc loader.load("https://xxx.html")# 分割文档对象 splitter RecursiveCharacterTextSplitter(max_length512) docs splitter.split(doc)# 转换文档对象为嵌入&#xff0c;并…

[ Linux ] git工具的基本使用(仓库的构建,提交)

1.安装git yum install -y git 2.打开Gitee&#xff0c;创建你的远程仓库&#xff0c;根据提示初始化本地仓库&#xff08;这里以我的仓库为例&#xff09; 新建好仓库之后跟着网页的提示初始化便可以了 3.add、commit、push三板斧 git add . //add仓库新增&#xff08;变…

V R元宇宙平台的未来方向|V R主题馆加 盟|游戏体验馆

未来&#xff0c;VR元宇宙平台可能会呈现出以下发展趋势和可能性&#xff1a; 全面融合现实与虚拟世界&#xff1a; VR元宇宙平台将更加无缝地融合现实世界和虚拟世界&#xff0c;用户可以在虚拟环境中进行各种活动&#xff0c;与现实世界进行互动&#xff0c;并且体验到更加逼…

【Linux进阶之路】理解UDP,成为TCP。

前言 学了TCP 和UDP之后&#xff0c;感觉UDP就像是初入职场的年轻人&#xff0c;两耳不闻 “窗外事”&#xff0c;只管尽力地把自己的事情做好&#xff0c;但收获的却是不可靠&#xff0c;而TCP更像是涉世极深的"职场老油条"&#xff0c;给人的感觉就是 “城府极深&a…

【Java.mysql】——数据删改(DU) 附加数据库约束

目录 &#x1f6a9;更新(Update) &#x1f6a9;删除&#xff08;Delete&#xff09; &#x1f6a9;数据库约束 &#x1f388;约束类型 ✅NULL约束 ✅NNIQUE 唯一约束 ✅DEFAULT&#xff1a;默认值约束 ✅PRIMARY KEY&#xff1a;主键约束 ✅FOREIGN KEY&#xff1a;外键…

性价比高一点的diy台式主机怎么搭配?

怎么搭配一台性价比高一点的台式机 建议&#xff1a; 选择合适的CPU和GPU。根据实际需求选择相对较新的CPU和GPU型号&#xff0c;以确保能够运行目标应用程序和游戏。 合理选择内存和存储。根据预算选择适当的内存和存储容量。8GB或16GB内存对于一般计算和游戏使用足够了&…

YOLOv9改进策略:IoU优化 | Wasserstein Distance Loss,助力小目标涨点

&#x1f4a1;&#x1f4a1;&#x1f4a1;本文独家改进&#xff1a;基于Wasserstein距离的小目标检测评估方法 Wasserstein Distance Loss | 亲测在多个数据集能够实现涨点&#xff0c;对小目标、遮挡物性能提升明显 &#x1f4a1;&#x1f4a1;&#x1f4a1;MS COCO和PASC…

【深度学习】深度学习md笔记总结第2篇:TensorFlow介绍,学习目标【附代码文档】

深度学习笔记完整教程&#xff08;附代码资料&#xff09;主要内容讲述&#xff1a;深度学习课程&#xff0c;深度学习介绍要求,目标,学习目标,1.1.1 区别,学习目标,学习目标。TensorFlow介绍&#xff0c;2.4 张量学习目标,2.4.1 张量(Tensor),2.4.2 创建张量的指令,2.4.3 张量…