前言
我们在工作中需要编写的技术文档有多种形式,包括Word、Excel、PDF及一些在线形式。我们可以借助ChatGPT生成文本,然而,它不能直接生成Word、Excel、PDF等格式的文档。因此,我们需要利用其他工具来帮助我们生成一些模板,并且可以在工作中使用这些模板,由程序员采用半自动的方式来编写技术文档,从而大大提高工作效率。
目录
-
准备工作
-
按部就班
- 提示语句
- 重点
- 基本语法
- Markdown工具
- 安装Markdown插件
- 生成Markdown格式文档
- 操作图示
- 将Markdown格式文档转成Word文档
- 将word转换为pdf格式
-
常见问题及其解决方案
-
命令行常用指令
-
英文拓展学习
-
参考资料
-
总结
准备工作
1、工具:VScode,文档转换工具pandoc,ChatGPT或其他AI辅助工具如CodeGeeX
2、确定需求:如:“QE后台管理系统需求文档”
3、你可以根据需求跳转至不同层次
按部就班
提示语句
请根据要求编写QE后台管理系统需求文档
:编写QE后台管理系统的需求文档需要详细描述系统的功能、非功能性需求和技术规格等方面的内容。以下是一个简化的需求文档框架,你可以根据具体的项目需求和实际情况进行扩展和修改。
# QE 后台管理系统需求说明书
## 1. 引言
- 说明需求说明书的目的和范围。
- 概述 QE 后台管理系统的基本功能和预期特性。
## 2. 项目概述
- 描述项目的背景和目标。
- 软件的整体范围和预期的用户群体。
## 3. 用户权限和管理
- 用户角色和权限定义。
- 用户登录和认证功能描述。
- 用户管理功能描述。
- 权限管理功能描述。
## 4. 数据管理
- 数据库管理功能描述。
- 数据备份与恢复功能描述。
- 数据统计与报表功能描述。
## 5. 系统设置和配置
- 系统参数配置功能描述。
- 日志管理功能描述。
- 邮件通知设置功能描述。
## 6. 安全性要求
- 用户数据加密与安全传输描述。
- 防止非法访问和攻击的措施描述。
## 7. 界面和用户体验
- 用户界面设计描述。
- 操作流程和易用性描述。
- 多语言支持和响应式设计描述。
## 8. 性能要求