效率提升: 使用记事本提升开发效率
关于文档
分享一些模板,用于加速开发效率。同样为了方便效率,推荐一部分工具。
笔记工具
- 语雀(可以系统的记录一些文档,例如项目中一些技巧点,将其放在一处)
- 幕布 (该工具我没有使用过,但我的同事在用,可以根据大纲生成思维导图,相当的强悍)
思维导图工具
- MindMaster
- XMind
已上都可以,通过思维导图的方式,查看记录内容的结构
敏捷看板工具
- 领歌
- JIRA
待办事项
============= 待办事项 =============
[日期]
[优先级] [任务名称]
- 任务描述或备注
[优先级] [任务名称]
- 任务描述或备注
...
=====================================
实例
============= 待办事项 =============
2023-05-10
[高] 完成报告撰写
- 编写周报告
- 整理数据
[中] 购买杂货
- 牛奶
- 面包
- 水果
=====================================
Bug修复
============= Bug 修复 =============
Bug 编号: [BUG_ID]
日期: [日期]
状态: [已修复 | 待验证 | 关闭]
问题描述:
[问题的详细描述,包括出现的场景、错误信息等]
原因分析:
[导致问题的根本原因分析]
解决方案:
[修复问题的具体方法和代码修改]
验证步骤:
[验证修复是否成功的步骤]
备注:
[其他相关信息]
=====================================
实例
# Bug 修复记录模板
## Bug 详情
- Bug 编号:BUG-123
- 修复状态:已修复
## 问题描述
在用户登录后,无法正确显示其购物车内容。
## 原因分析
由于计算购物车商品数量的逻辑错误,导致显示错误的数量。
## 解决方案
修改购物车数量计算逻辑,确保正确计算商品数量。
## 验证步骤
1. 登录用户账号。
2. 进入购物车页面,验证显示的商品数量是否正确。
## 备注
修复后,购物车页面应显示正确的商品数量。
功能开发记录
============= 功能开发 =============
功能编号: [FEATURE_ID]
日期: [日期]
状态: [开发中 | 已完成 | 关闭]
需求描述:
[需求的详细描述,包括功能的目的和预期效果]
设计方案:
[功能的设计方案,包括界面设计、数据库变更等]
实现细节:
[功能的具体实现细节,包括代码逻辑、API设计等]
测试计划:
[功能的测试计划,包括单元测试、集成测试等]
备注:
[其他相关信息]
=====================================
实例
# 功能开发记录模板
## 功能详情
- 功能编号:FEATURE-003
- 状态:待开发
## 需求描述
用户应能够在商品详情页面发表评论,查看其他用户的评论。
## 设计方案
- 在商品详情页面显示评论区域和发表评论的表单。
- 前端将评论内容发送到后端 API 进行保存。
- 后端将评论存储到数据库,包括关联的商品和用户信息。
## 实现细节
- 前端设计评论区域和评论表单,使用 JavaScript 发送评论数据。
- 后端实现评论保存逻辑,关联用户和商品信息。
- 数据库表设计:comments(id, user_id, product_id, content, timestamp)。
## 测试计划
1. 打开商品详情页面,输入评论内容,点击提交按钮。
2. 验证评论是否正确保存,并能够在页面正确显示。
## 备注
用户评论应能够与关联的商品正确关联,并能够展示在商品页面上。
学以致用,知行合一