|
|
@@ -87,3 +87,103 @@
|
|
|
# Token 节省准则
|
|
|
|
|
|
@RTK.md
|
|
|
+
|
|
|
+# 项目专用准则
|
|
|
+
|
|
|
+## 文档资源目录
|
|
|
+
|
|
|
+项目 `docs/` 目录包含 5 类文档，覆盖设计、规划、规格、参考与补丁。实施任何功能前必读相关文档，避免重复设计或遗漏关键约束。
|
|
|
+
|
|
|
+### 设计文档（design/）
|
|
|
+
|
|
|
+架构设计与技术方案设计，共 11 篇。涵盖：
|
|
|
+
|
|
|
+**工作流核心机制**：
|
|
|
+- 节点字段与 IO 类型（`workflow-node-fields-design.md`）
|
|
|
+- 上下文传递机制（`workflow-context-passing-design.md`）
|
|
|
+- 输出信封化（`workflow-output-envelope-design.md`）
|
|
|
+- 变量作用域与命名空间（`workflow-variable-scope-design.md`）
|
|
|
+
|
|
|
+**RAG 系统**：
|
|
|
+- 整体架构与前瞻性优化（`rag-advanced-architecture-design.md`）
|
|
|
+- Graph RAG 设计（`graph-rag-design.md`）
|
|
|
+- 本地语义切分（`local-semantic-chunking-design.md`）
|
|
|
+- 结构化数据 RAG（`structured-data-rag-design.md`）
|
|
|
+
|
|
|
+**其他**：
|
|
|
+- Hermes 沙箱隔离设计（`hermes-sandbox-design.md`）
|
|
|
+- 聊天界面设计（`agent-chat-page-design.md`）
|
|
|
+
|
|
|
+**作用**：系统性设计决策的权威文档，实施前必读。
|
|
|
+
|
|
|
+### 实施计划（plans/）
|
|
|
+
|
|
|
+具体功能实施计划，共 8 篇。包括：
|
|
|
+
|
|
|
+**智能体工作流**：
|
|
|
+- AGENTIC 模式（自主智能体工作流）实施（`agentic-workflow-plan.md`）
|
|
|
+- AGENTIC 重访决策机制（`agentic-revisit-decision-plan.md`）
|
|
|
+
|
|
|
+**Hermes 相关**：
|
|
|
+- 错误检测与重试机制（`hermes-error-detection-plan.md`）
|
|
|
+- 思考过程展示重构（`hermes-thinking-display-overhaul-plan.md`）
|
|
|
+
|
|
|
+**工作流引擎**：
|
|
|
+- 节点上下文按需加载（`node-context-ondemand-plan.md`）
|
|
|
+- 数据流执行模型（`workflow-dataflow-execution-plan.md`）
|
|
|
+- 信封严格验证（`workflow-envelope-strict-validation-plan.md`）
|
|
|
+- 输出模式约束（`workflow-output-schema-constraint-plan.md`）
|
|
|
+- 调度引擎（`workflow-scheduling-engine-plan.md`）
|
|
|
+
|
|
|
+**作用**：分步实施路线图，含需求确认、技术方案、任务拆解。
|
|
|
+
|
|
|
+### 规格文档（specs/）
|
|
|
+
|
|
|
+接口规范与功能规格，共 3 篇：
|
|
|
+
|
|
|
+- 外部工作流 API（`external-workflow-api-spec.md`）
|
|
|
+- 标签系统（`tag-system-spec.md`）
|
|
|
+- 工作流 CRUD API（`workflow-crud-api-spec.md`）
|
|
|
+
|
|
|
+**作用**：API 契约、输入输出约束、校验规则的定义文档。
|
|
|
+
|
|
|
+### 参考文档（reference/）
|
|
|
+
|
|
|
+外部项目参考与机制说明，共 7 篇：
|
|
|
+
|
|
|
+**同类项目参考**：
|
|
|
+- Dify 平台总览（`dify-reference.md`）
|
|
|
+- Dify 工作流节点（`dify-workflow-nodes-reference.md`）
|
|
|
+- 即刻平台（`jizhi-platform-reference.md`）
|
|
|
+- Super Mew（`super-mew-reference.md`）
|
|
|
+
|
|
|
+**Hermes 机制**：
|
|
|
+- Hermes-Agent 上游升级（`hermes-agent-upgrade-reference.md`）
|
|
|
+- Hermes 上下文压缩与记忆（`hermes-context-memory-reference.md`）
|
|
|
+
|
|
|
+**其他**：
|
|
|
+- RAG 集成参考（`rag-integration-reference.md`）
|
|
|
+- 技能管理（`skills-manage-reference.md`）
|
|
|
+- 工作流 vs Dify 对比（`workflow-vs-dify-comparison.md`）
|
|
|
+
|
|
|
+**作用**：技术选型依据、同类方案对比、上游依赖评估。
|
|
|
+
|
|
|
+### 补丁说明（patches/hermes-agent/）
|
|
|
+
|
|
|
+Hermes-Agent 私有修改记录（`README.md`）。
|
|
|
+
|
|
|
+**作用**：记录对上游 Hermes 的 fork 与 patch，便于追踪差异、评估升级风险。
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 使用流程
|
|
|
+
|
|
|
+实施新功能时的标准流程：
|
|
|
+
|
|
|
+1. **查设计文档**：理解系统性设计决策与技术约束
|
|
|
+2. **查实施计划**：确认是否已有计划，避免重复工作
|
|
|
+3. **查规格文档**：明确接口契约、输入输出、校验规则
|
|
|
+4. **查参考文档**：参考同类项目实现、上游依赖特性
|
|
|
+5. **查补丁说明**（若涉及 Hermes）：确认私有修改与上游差异
|
|
|
+
|
|
|
+**关键原则**：先读文档再动手，设计决策自上而下（design → plans → specs），避免重复设计或遗漏关键约束。
|
