diff --git a/.planning/REQUIREMENTS.md b/.planning/REQUIREMENTS.md new file mode 100644 index 0000000..43ffdd8 --- /dev/null +++ b/.planning/REQUIREMENTS.md @@ -0,0 +1,87 @@ +# Requirements: kb-skills v1.1 Architecture Refactor + +**Defined:** 2026-03-16 +**Core Value:** 可靠、可维护的处理管道 - 每个步骤独立、可验证、可恢复 + +## v1.1 Requirements + +### 中间目录 (Intermediate) + +- [ ] **INT-01**: 中间目录统一到 `~/work/intermediate/analysis/` +- [ ] **INT-02**: 内容目录命名保持 `{platform}_{content_id}/` 格式 +- [ ] **INT-03**: 配置文件支持自定义中间目录路径 + +### 归档步骤 (Archive) + +- [ ] **ARC-01**: 添加 ArchiveProcessor 作为管道最后一步 +- [ ] **ARC-02**: 分析完成后自动归档到最终目录 +- [ ] **ARC-03**: 归档只复制 md 文件到最终目录 +- [ ] **ARC-04**: 归档后可选清理中间文件 + +### 最终目录结构 (Output) + +- [ ] **OUT-01**: 最终目录按平台分目录 (bilibili/, zhihu/) +- [ ] **OUT-02**: 不再按时间创建归档目录 +- [ ] **OUT-03**: 文件前缀加时间戳 `{timestamp}_{content_id}_analysis.md` +- [ ] **OUT-04**: 只保留 md 文件,不归档 json 文件 + +### 代码整合 - 元数据 (Metadata Integration) + +- [ ] **MET-01**: kb-bilibili-metadata 整合进 kb-workflow/metadata/ +- [ ] **MET-02**: kb-zhihu-metadata 整合进 kb-workflow/metadata/ +- [ ] **MET-03**: 删除独立的 kb-bilibili-metadata 目录 +- [ ] **MET-04**: 删除独立的 kb-zhihu-metadata 目录 +- [ ] **MET-05**: 更新所有导入路径指向新位置 + +### 代码整合 - Pipeline (Pipeline Integration) + +- [ ] **PIP-01**: kb_pipeline/ 合并进 kb-workflow/ +- [ ] **PIP-02**: 保持 processors/, platforms/, schemas.py, state.py, config.py 结构 +- [ ] **PIP-03**: 删除独立的 kb_pipeline 目录 +- [ ] **PIP-04**: 更新 CLI 入口导入路径 + +## v2 Requirements + +Deferred to future release. + +### 进度与性能 + +- **ADV-01**: 进度可见性 — 实时显示工作流执行进度 +- **ADV-02**: 并行步骤执行 — 支持独立步骤的并行执行 +- **ADV-03**: 说话者分离默认启用 — HF_TOKEN 配置后自动使用 + +### 平台扩展 + +- **EXT-01**: 微信公众号处理 — 支持微信公众号文章 + +## Out of Scope + +| Feature | Reason | +|---------|--------| +| 实时/流式处理 | 批量处理即可 | +| 并发限制 | 不需要限制并发数量 | +| 用户界面 | 命令行运行 | +| 多语言支持 | 中文即可 | +| 小红书 | 当前不支持 | +| 归档 json 文件 | 只保留最终 md 分析报告 | + +## Traceability + +Updated during roadmap creation. + +| Requirement | Phase | Status | +|-------------|-------|--------| +| INT-01 ~ INT-03 | Phase 5 | Pending | +| ARC-01 ~ ARC-04 | Phase 5 | Pending | +| OUT-01 ~ OUT-04 | Phase 5 | Pending | +| MET-01 ~ MET-05 | Phase 6 | Pending | +| PIP-01 ~ PIP-04 | Phase 6 | Pending | + +**Coverage:** +- v1.1 requirements: 18 total +- Mapped to phases: 18 +- Unmapped: 0 ✓ + +--- +*Requirements defined: 2026-03-16* +*Last updated: 2026-03-16 after initial definition*