tapd-similar-requirements-skill-pack 是做什么的?
用于 TAPD 相似需求召回与深度阅读的 Codex 技能包
概述
该技能包为 Codex 平台提供了一套工具,用于在 TAPD 中进行相似需求的智能检索和详细分析。它能够帮助团队快速定位与当前需求相关的历史条目,减少重复工作,并提升需求评审的准确性。
功能
- 相似需求召回:基于文本相似度算法,从 TAPD 需求池中自动召回与目标需求相似的条目。
- 深度阅读:对单个需求进行深入分析,提取关键信息,如描述、附件、评论等。
- 集成 TAPD API:通过 TAPD 的 API 接口无缝获取需求数据,无需手动导出。
- 结果结构化:将召回和分析结果以清晰、易读的格式呈现给用户,方便后续决策。
使用场景
- 需求评审:在评审新需求时,快速查看是否有相同或相似的需求已被提出。
- 避免重复:防止团队在不知情的情况下重复实现已有功能。
- 需求排期:为需求的优先级排序提供历史参考。
前提条件
- 拥有 TAPD 账号并具备相应项目的访问权限。
- 在 TAPD 中已配置好用于 API 访问的令牌(Token)。
- Codex 环境已正确配置,并安装了本技能包。
安装
- 将本仓库克隆到本地。
- 在 Codex 的配置文件中添加或启用本技能包。
- 设置环境变量
TAPD_API_TOKEN和TAPD_API_URL以连接到您的 TAPD 实例。
使用方法
召回相似需求
使用以下命令在 Codex 的输入框中触发相似需求召回:
find_similar_requirements "目标需求的标题或ID"
深度阅读某个需求
若要查看某个需求的完整详情,可以使用:
deep_read_requirement "需求ID"
配置
在您的环境或 .env 文件中设置以下变量:
| 变量名 | 描述 | 是否必须 |
|---|---|---|
TAPD_API_TOKEN | TAPD API 访问令牌 | 是 |
TAPD_API_URL | TAPD 实例的 API 基础 URL | 是 |
TAPD_PROJECT_ID | 目标项目 ID(可选,默认为全局检索) | 否 |
贡献
欢迎提交 Issue 和 Pull Request 来改进本技能包。请遵循项目的代码规范和提交标准。