tangweijie 542a06907c docs: 增加 TAPD 协作约定与项目绑定
为仓库补充 TAPD 本地协作入口,固化默认 workspace、查询范围与输出模板,便于后续按统一口径开展需求与任务跟踪。

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-17 10:43:00 +08:00

141 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# TAPD 输出模板
## 1. 规范文档型:需求/任务查询结果
### 输出模板
- 项目:`{{workspace_name}}``{{workspace_id}}`
- 对象类型:`{{entity_type}}`
- 查询条件:`{{query_summary}}`
- 结果摘要:`{{summary}}`
#### 明细
| 编号 | 标题 | 状态 | 负责人 | 计划时间 | 备注 |
|------|------|------|--------|----------|------|
| {{id}} | {{name}} | {{status}} | {{owner}} | {{schedule}} | {{note}} |
#### 结论
- 当前结论:{{conclusion}}
- 后续动作:{{next_action}}
## 2. 规范文档型:缺陷跟踪结果
### 输出模板
- 项目:`{{workspace_name}}``{{workspace_id}}`
- 缺陷范围:`{{query_summary}}`
- 结果摘要:`{{summary}}`
| 缺陷ID | 标题 | 状态 | 严重程度 | 处理人 | 备注 |
|--------|------|------|----------|--------|------|
| {{id}} | {{title}} | {{status}} | {{severity}} | {{owner}} | {{note}} |
## 3. 规范文档型:迭代汇报
### 输出模板
- 项目:`{{workspace_name}}``{{workspace_id}}`
- 迭代:`{{iteration_name}}`
- 时间范围:`{{date_range}}`
#### 进展概览
- 已完成:{{done_summary}}
- 进行中:{{progressing_summary}}
- 风险项:{{risk_summary}}
#### 建议关注
- {{focus_1}}
- {{focus_2}}
- {{focus_3}}
## 4. 粒度映射模板
### TAPD 与 speckit 对齐关系
| TAPD 层级 | speckit 对应物 | 说明 |
|-----------|----------------|------|
| Epic / 大主题 | feature 背景 | 例如 REV-005 这类主题范围 |
| Story | `spec.md` | 最小需求粒度,一个可独立评审与交付的设计闭环 |
| Task | `tasks.md` 中的任务项 | 具体执行动作,如修改某篇文档、补某张表、校核某组引用 |
### 立项判断规则
优先作为一个独立 Story / speckit feature 的情形:
- 需要跨两篇及以上主文档协同修改
- 需要同时对齐详细设计、接口设计、数据库设计中的两类及以上内容
- 具备明确边界、验收标准与独立评审价值
优先作为 Task 的情形:
- 单字段修订
- 单表格补充
- 单文档局部改写
- 链接、标题、编号等局部一致性修复
### speckit feature 命名模板
#### 推荐命名公式
`<主题编号>-<场景关键词>-<交付动作>`
#### 推荐写法
- `rev005-invoice-apply-design`
- `rev005-invoice-redflush-alignment`
- `rev005-invoice-status-rules`
- `rev005-invoice-db-interface-sync`
#### 中文标题模板
`<主题编号><业务场景><交付动作>`
示例:
- `REV-005补齐发票开具申请设计闭环`
- `REV-005统一发票红冲字段口径`
- `REV-005补齐发票状态流转规则`
#### 命名约束
- 使用小写英文与连字符 `-`
- 不使用空格、中文、下划线
- 主题编号放在最前面,便于同批需求聚类
- 场景关键词优先写业务对象,不要只写模块名
- 交付动作优先使用 `design``alignment``rules``sync``cleanup` 等可辨识词
- 一个 feature 名称只表达一个独立交付目标,不混入多个并列场景
#### 交付动作建议词表
- `design`:补齐某业务场景设计闭环
- `alignment`:统一多文档之间的字段或口径
- `rules`:补齐规则、状态流转、约束条件
- `sync`:做跨文档同步与一致性收口
- `cleanup`:处理遗留结构、引用、编号、术语收口
#### 快速套用模板
- 场景设计类:`<topic>-<scenario>-design`
- 口径统一类:`<topic>-<scenario>-alignment`
- 规则补齐类:`<topic>-<scenario>-rules`
- 跨文档收口类:`<topic>-<scenario>-sync`
#### 当前仓库推荐示例
- `rev005-invoice-apply-design`
- `rev005-invoice-issue-result-sync`
- `rev005-invoice-redflush-alignment`
- `rev005-invoice-status-rules`
- `rev005-invoice-db-interface-sync`
## 术语偏好
- story需求
- task任务
- bug缺陷
- iteration迭代