ken.li
44b13c96f6
- 添加已推送提交检查，避免不安全的 amend 操作
- 规范文档保存路径为 `doc/{日期}` 格式
- 扩展 markdown 解析支持表格和更多格式
- 优化 Jira 搜索 API 调用方式
2.1 KiB
2.1 KiB
Jira 工单附件文档政策（公司强制性指南）
自 2026年3月9日 起，以下为将 开发计划、影响分析、任务摘要 附加到 Jira 工单的强制性指南，用于跟踪设计决策、评估风险、为未来参考提供背景及项目间协作。
一般规则（经验法则）
| 场景 | 需要附加的文档 |
|---|---|
| 漏洞修复 | 仅包括 影响分析（若修复有非简单副作用） |
| 新功能 / 重大核心变更 | 全部三个文件：开发计划、影响分析、任务摘要 |
| 琐碎 / 小改动 | 无需文件 |
详细条件（按任务类型）
| 任务类型 | 开发计划 | 影响分析 | 任务摘要 |
|---|---|---|---|
| 漏洞修复——简单（如拼写错误、界面对齐） | ❌ | ❌ | ❌ |
| 漏洞修复——中等（如范围有限的逻辑错误） | ❌ | ✅ | ❌ |
| 漏洞修复——复杂/高风险（如并发、核心模块） | ✅ | ✅ | ✅ |
| 小幅度增强（如添加小效用方法） | ❌ | ✅ | ❌ |
| 新功能/模块 | ✅ | ✅ | ✅ |
| 主要重构 | ✅ | ✅ | ✅ |
| 配置/基础设施变更 | ❌ | ✅ | ❌ |
文档含义说明
- 开发计划：概述步骤、设计方法和技术决策。
- 影响分析：列出受影响区域、风险、性能考虑因素及向后兼容性。
- 任务摘要：简要回顾所完成的工作，包括任何偏离计划的地方。
提交方式与命名规范
- 将文件（Markdown）直接放在工单的附件部分。
- 使用一致的命名规范：
<JIRA-ID>_Dev_Plan.md<JIRA-ID>_Impact_Analysis.md<JIRA-ID>_Task_Summary.md
示例：工单 G3SF-123 的三个附件命名为
G3SF-123_Dev_Plan.md、G3SF-123_Impact_Analysis.md、G3SF-123_Task_Summary.md。
本地保存路径：
- 所有文档统一保存到项目根目录下的
doc/{日期}文件夹 - 日期格式为
YYYY-MM-DD（如doc/2026-03-26） - 若该文件夹不存在，必须先创建再保存文件
- 完整路径示例：
doc/2026-03-26/G3SF-123_Impact_Analysis.md