From ae64242d2e89e7dbf4e87a44c3b356feb68c4e02 Mon Sep 17 00:00:00 2001 From: many2many <6168830@qq.com> Date: Sun, 12 May 2024 16:13:08 +0800 Subject: [PATCH] [add]task guide doc --- docs/tasks/任务1-项目启动与开发模型学习.md | 46 +++++++++++++ docs/tasks/任务2-需求分析和管理.md | 64 +++++++++++++++++++ ....md => 任务3-Sprint-1-创建spring boot初始项目.md} | 0 ... => 任务4-Sprint-1-restful接口回应数据的统一封装的实现.md} | 0 ...常处理.md => 任务5-Sprint-1-实现统一异常处理.md} | 0 ...接口实现.md => 任务6-Sprint-1-注册接口实现.md} | 4 +- .../任务7-Sprint-1-基于JWT的用户认证实现.md | 27 ++++++++ docs/tasks/任务模板.md | 27 ++++++++ docs/tasks/泡泡开源社区实训开发.md | 59 +++++++++++++++++ 9 files changed, 225 insertions(+), 2 deletions(-) create mode 100644 docs/tasks/任务1-项目启动与开发模型学习.md create mode 100644 docs/tasks/任务2-需求分析和管理.md rename docs/tasks/{任务1-创建spring boot初始项目.md => 任务3-Sprint-1-创建spring boot初始项目.md} (100%) rename docs/tasks/{任务2-restful接口回应数据的统一封装的实现.md => 任务4-Sprint-1-restful接口回应数据的统一封装的实现.md} (100%) rename docs/tasks/{任务3-实现统一异常处理.md => 任务5-Sprint-1-实现统一异常处理.md} (100%) rename docs/tasks/{任务-注册接口实现.md => 任务6-Sprint-1-注册接口实现.md} (98%) create mode 100644 docs/tasks/任务7-Sprint-1-基于JWT的用户认证实现.md create mode 100644 docs/tasks/任务模板.md create mode 100644 docs/tasks/泡泡开源社区实训开发.md diff --git a/docs/tasks/任务1-项目启动与开发模型学习.md b/docs/tasks/任务1-项目启动与开发模型学习.md new file mode 100644 index 0000000..37ea182 --- /dev/null +++ b/docs/tasks/任务1-项目启动与开发模型学习.md @@ -0,0 +1,46 @@ +## 任务名称: 项目启动 +### 目标: +- 了解项目开发流程、开发模式、开发工具等。 +- git基本使用 + +### 预备知识: +- git + +### 操作步骤: +1. **组建团队** + +> 6-7人一组,推选组长,确定成员角色。 + +2. **创建项目仓库** +- 创建项目Git仓库 +> 在gitea(http://60.204.241.255:8066)注册帐号,创建项目仓库。 + +- 将团队成员加入项目仓库。 + +3. 编辑项目README.md文件 +> 项目简单描述、团队成员、开发模式、开发工具等。 +> 各成员clone项目到本地。 +> 各成员编辑README.md文件,填写自己的名字,提交到仓库。 + +3. **scrum学习** + +[scrum快速入门](../guides/scrum快速入门.md) + +4. **敏捷需求管理学习** + +[敏捷需求管理快速入门教程](../guides/敏捷需求管理快速入门教程.md) + +### 技术/工具需求: +- [列出完成任务所需的技术栈、工具、软件版本等。] + +### 成功标准: +- [明确完成任务的评判标准,如代码功能实现、性能指标、测试通过条件等。] + +### 扩展学习(可选): +- [提供一些额外学习资源或挑战性任务,鼓励学有余力的学生进一步探索。] + +### 评估与反馈: +- [说明如何提交作业、代码审查的标准、或任何反馈收集机制。] + +### 时间估算: +- [给出预计完成该任务所需的时间,帮助学生合理安排学习计划。] \ No newline at end of file diff --git a/docs/tasks/任务2-需求分析和管理.md b/docs/tasks/任务2-需求分析和管理.md new file mode 100644 index 0000000..e93d166 --- /dev/null +++ b/docs/tasks/任务2-需求分析和管理.md @@ -0,0 +1,64 @@ +## 任务名称: 需求分析和管理 +### 目标: +- 掌握敏捷需求的撰写 +- 掌握在gitea上通过工单方式管理需求 + +基于您提供的任务描述,以下是详细完成操作步骤1-6的指南: + +### 预备知识: +- 对Web应用和社区系统的基本理解。 +- 熟悉Git版本控制系统。 +- 了解敏捷开发和Scrum框架的基本原则。 + +### 操作步骤: + +1. **通过演示系统了解需求** + - 访问提供的演示系统链接:http://60.204.241.255:8008 + - 浏览演示系统,了解其功能和用户交互流程。 + +2. **在gitea的工单系统中创建标签** + - Epic、Feature、UserStory、Task等。 + +3. **编写项目的Epic** + - 登录到gitea平台。 + - 在项目的工单中,创建一个新的Epic。 + - 描述整个项目的需求 + +4. **编写项目的Feature** + - 在同一个项目的工单部分,为Epic创建相关的Feature。 + - 每个Feature Issue应该描述一个具体的功能 + +5. **编写User Story** + - 在每个Feature下,创建多个User Story。 + - 用户故事应该遵循“作为[角色],我希望[目标],以便[理由]”的格式,例如:“作为一个新用户,我希望能够注册账户,以便我可以发布消息和评论。” + - gitea中在工单中创建用户故事:用户注册 + - gitea中在工单中创建用户故事:用户登录 + - gitea中在工单中创建用户故事:项目基础架构 + +6. **评审用户故事** + - 与团队成员一起评审用户故事,确保它们是可测试的、具体的,并且提供价值。 + - 收集反馈,并根据反馈调整用户故事。 + +7. **启动sprint 1** + - 在gitea上创建一个新的里程碑,命名为“Sprint 1”。 + - 根据优先级和难度,选择一些用户故事添加到“Sprint 1”里程碑中。 + - 这些用户故事将构成第一个Sprint的工作内容。 + +### 技术/工具需求: +- Git和Gitea的基本操作知识。 +- 熟悉Web浏览器和在线协作工具。 +- 基本的项目管理技能。 + +### 成功标准: +- 用户故事清晰、具体,并且可执行。 +- Epic和Feature Issues得到适当的分解和描述。 +- 至少完成一个Sprint的规划,包括用户故事的选择和里程碑的创建。 + +### 扩展学习(可选): + + +### 评估与反馈: + + +### 时间估算: +- 预计完成该任务所需的时间:。 diff --git a/docs/tasks/任务1-创建spring boot初始项目.md b/docs/tasks/任务3-Sprint-1-创建spring boot初始项目.md similarity index 100% rename from docs/tasks/任务1-创建spring boot初始项目.md rename to docs/tasks/任务3-Sprint-1-创建spring boot初始项目.md diff --git a/docs/tasks/任务2-restful接口回应数据的统一封装的实现.md b/docs/tasks/任务4-Sprint-1-restful接口回应数据的统一封装的实现.md similarity index 100% rename from docs/tasks/任务2-restful接口回应数据的统一封装的实现.md rename to docs/tasks/任务4-Sprint-1-restful接口回应数据的统一封装的实现.md diff --git a/docs/tasks/任务3-实现统一异常处理.md b/docs/tasks/任务5-Sprint-1-实现统一异常处理.md similarity index 100% rename from docs/tasks/任务3-实现统一异常处理.md rename to docs/tasks/任务5-Sprint-1-实现统一异常处理.md diff --git a/docs/tasks/任务-注册接口实现.md b/docs/tasks/任务6-Sprint-1-注册接口实现.md similarity index 98% rename from docs/tasks/任务-注册接口实现.md rename to docs/tasks/任务6-Sprint-1-注册接口实现.md index b687455..c259c75 100644 --- a/docs/tasks/任务-注册接口实现.md +++ b/docs/tasks/任务6-Sprint-1-注册接口实现.md @@ -1,9 +1,9 @@ -### 任务名称: 实现注册接口 +## 任务名称: 实现注册接口 #### 目标: - 掌握Restful API设计 - 掌握RestController类的使用 - 掌握JPA Entity类的使用 -- 掌握JPARepository接口的使用 +- 掌握JPA Repository接口的使用 #### 预备知识: - Restful API设计 diff --git a/docs/tasks/任务7-Sprint-1-基于JWT的用户认证实现.md b/docs/tasks/任务7-Sprint-1-基于JWT的用户认证实现.md new file mode 100644 index 0000000..84a0f0c --- /dev/null +++ b/docs/tasks/任务7-Sprint-1-基于JWT的用户认证实现.md @@ -0,0 +1,27 @@ +## 任务名称: 任务7-基于JWT的用户认证实现 +### 目标: +- [简要说明此任务旨在达成的具体学习目标或技能提升点。] + +### 预备知识: +- [列出完成该任务前学生应具备的基础知识或先修技能,如特定编程语言基础、框架了解等。] + +### 操作步骤: +1. **步骤1**: [详细描述第一步操作,包括使用的工具、命令或技术要点。] +2. **步骤2**: [继续描述后续步骤,确保每一步都清晰、可执行。] + ... + [根据需要添加更多步骤] + +### 技术/工具需求: +- [列出完成任务所需的技术栈、工具、软件版本等。] + +### 成功标准: +- [明确完成任务的评判标准,如代码功能实现、性能指标、测试通过条件等。] + +### 扩展学习(可选): +- [提供一些额外学习资源或挑战性任务,鼓励学有余力的学生进一步探索。] + +### 评估与反馈: +- [说明如何提交作业、代码审查的标准、或任何反馈收集机制。] + +### 时间估算: +- [给出预计完成该任务所需的时间,帮助学生合理安排学习计划。] \ No newline at end of file diff --git a/docs/tasks/任务模板.md b/docs/tasks/任务模板.md new file mode 100644 index 0000000..66dad5a --- /dev/null +++ b/docs/tasks/任务模板.md @@ -0,0 +1,27 @@ +## 任务名称: [具体任务标题] +### 目标: +- [简要说明此任务旨在达成的具体学习目标或技能提升点。] + +### 预备知识: +- [列出完成该任务前学生应具备的基础知识或先修技能,如特定编程语言基础、框架了解等。] + +### 操作步骤: +1. **步骤1**: [详细描述第一步操作,包括使用的工具、命令或技术要点。] +2. **步骤2**: [继续描述后续步骤,确保每一步都清晰、可执行。] + ... + [根据需要添加更多步骤] + +### 技术/工具需求: +- [列出完成任务所需的技术栈、工具、软件版本等。] + +### 成功标准: +- [明确完成任务的评判标准,如代码功能实现、性能指标、测试通过条件等。] + +### 扩展学习(可选): +- [提供一些额外学习资源或挑战性任务,鼓励学有余力的学生进一步探索。] + +### 评估与反馈: +- [说明如何提交作业、代码审查的标准、或任何反馈收集机制。] + +### 时间估算: +- [给出预计完成该任务所需的时间,帮助学生合理安排学习计划。] \ No newline at end of file diff --git a/docs/tasks/泡泡开源社区实训开发.md b/docs/tasks/泡泡开源社区实训开发.md new file mode 100644 index 0000000..76ed91b --- /dev/null +++ b/docs/tasks/泡泡开源社区实训开发.md @@ -0,0 +1,59 @@ + +## 基于Scrum的实训项目开发 + +### 1. **项目背景与目标设定** +- **定义项目** +> 基于开源项目paopao-ce,使用其前端,使用spring boot开发后端系统 +- **明确目标** +> - 了解scrum开发流程,理解scrum开发模式,了解scrum开发模式中的角色和职责,了解scrum开发模式中的 artefact(工件) + +> - 掌握基于spring boot框架的开发 + +> - 掌握基于git的协作开发流程 + +> - 了解CI/CD流程 + +### 2. **Scrum团队组建** +- **角色分配**: + - **产品负责人(Product Owner, PO)**:负责定义用户故事,确定产品功能的优先级,代表客户利益。 + - **Scrum Master**:保障Scrum流程顺畅执行,解决过程中遇到的障碍,促进团队自我管理。 + - **开发团队**:跨职能团队,负责设计、开发和测试工作,自主决定如何实现产品功能。 + +**练习任务**: [任务1 项目启动](./任务1-项目启动与开发模型学习.md) + +### 3. **Scrum工件准备** +- **产品待办事项列表(Product Backlog)**:PO创建并维护,列出所有需求项,作为工作的来源。 +- **Sprint待办事项列表(Sprint Backlog)**:每次Sprint开始时,团队从产品待办事项列表中挑选最高优先级的事项,形成Sprint待办事项列表。 +- **迭代计划会议(Sprint Planning)**:确定Sprint目标,选择本次迭代要完成的工作项,并估算工作量。 + +**练习任务**: [任务2 需求分析和管理](./任务2-需求分析和管理) + +### 4. **Sprint周期与仪式** +- **Sprint周期**:建议2-4周,根据项目复杂度和学生可用时间调整。 +- **每日立会(Daily Scrum)**:每天简短会议,团队分享昨日进展、今日计划及遇到的障碍。 +- **Sprint评审会议(Sprint Review)**:Sprint结束时展示成果给PO和其他利益相关者,收集反馈。 +- **Sprint回顾会议(Sprint Retrospective)**:团队反思过去Sprint的流程,讨论改进措施。 + +**冲刺周期一的任务** +- [任务3 创建spring boot初始项目](./任务3-Sprint-1-创建spring%20boot初始项目.md) +- [任务4-restful接口回应数据的统一封装的实现t](./任务4-Sprint-1-restful接口回应数据的统一封装的实现.md) +- [任务5-实现统一异常处理](./任务5-Sprint-1-实现统一异常处理.md) +- [任务6-注册接口实现](./任务6-Sprint-1-注册接口实现.md) +- [任务7-基于JWT的用户认证实现](./任务7-Sprint-1-基于JWT的用户认证实现.md) + +### 5. **敏捷实践应用** +- **用户故事**:使用用户故事来描述需求,确保团队关注用户价值。 +- **工作可视化**:使用看板或任务板来可视化工作进度,增强透明度。 +- **持续集成与交付(CI/CD)**:教授并实践自动化构建和部署,快速反馈代码质量。 + +### 6. **评估与反馈循环** +- **迭代反馈**:每个Sprint结束后,通过回顾会议收集反馈,不断优化流程。 +- **个人成长**:鼓励学生反思个人在敏捷团队中的角色和贡献,设定个人成长目标。 + +### 7. **工具与资源** +- **工具推荐** +> 使用gitea进行项目管理和问题追踪 +> +> 使用gitea进行版本控制。 + +- **学习资源**