33 lines
4.9 KiB
JSON
33 lines
4.9 KiB
JSON
{
|
||
"rules": [
|
||
{
|
||
"path": "**/*.md",
|
||
"rule": "文档评审 10 维度（项目 AGENTS.md + CONCEPTS.md 词汇表规范）：1) 准确性 — 与代码实现一致，无过时信息（API 路径/命令/版本号必须可验证），引用的模块路径/类名/函数名必须真实存在；2) 完整性 — 覆盖关键模块、API、配置项、边界条件、错误处理、部署步骤，无关键遗漏；3) 一致性 — 术语统一（必须与 CONCEPTS.md 领域词汇表对齐：专家团队状态机 FORMING→PLANNING→EXECUTING→SYNTHESIZING→COMPLETED→DISSOLVED、ExecutionMode DIRECT_CHAT/REACT/SKILL_REACT/REWOO/REFLEXION/PLAN_EXEC/TEAM_COLLAB、RequestPreprocessor 三层路由等），命名规范（中英混排空格、代码用反引号）；4) 可维护性 — docs/solutions/ 必须有 YAML frontmatter（module/tags/problem_type 可搜索），结构清晰（标题层级 ≤4 级），有目录/索引；5) 受众适配 — 区分新人 onboarding / 专家参考 / 运维部署，提供前置条件与后续步骤；6) 示例有效性 — 代码块必须带语言标签（bash/python/ts/vue），命令必须可复制运行（含完整路径与参数），示例输出与实际一致；7) 链接完整性 — 内部链接（相对路径）指向真实存在文件，外部链接有效，无 404；8) 安全合规 — 不泄露密钥/token/内部域名，敏感配置用占位符（<api-key>），不暴露内部架构细节给外部；9) 格式规范 — Markdown 语法正确，标题层级连续不跳级，列表缩进一致，表格对齐，frontmatter YAML 合法；10) 版本同步 — 引用的版本号必须与 pyproject.toml / package.json 一致，命令（agentkit/pip/npm）必须与实际 CLI 一致。"
|
||
},
|
||
{
|
||
"path": "**/docs/solutions/**/*.md",
|
||
"rule": "解决方案文档专项（docs/solutions/）：1) YAML frontmatter 必须包含 module（模块路径）、tags（标签数组）、problem_type（bug_fix/best_practice/architecture_pattern 之一），且可被搜索工具检索；2) 结构必须包含 — 问题描述/根因分析/解决方案/验证方法/影响范围/后续改进；3) 根因分析必须给出代码定位（文件:行号）；4) 解决方案必须含代码示例（修复前/修复后对比）；5) 验证方法必须可复现（命令或测试）；6) 引用的类名/函数名/模块路径必须与当前代码库一致；7) 中文撰写，代码注释中文；8) 标题命名规范 — <模块>-<问题简述>。"
|
||
},
|
||
{
|
||
"path": "**/docs/plans/**/*.md",
|
||
"rule": "计划文档专项（docs/plans/）：1) 文件名格式 YYYY-MM-DD-NNN-<type>-<name>-plan.md；2) 必须包含 — 背景与目标 / 现状分析 / 设计方案 / 任务拆解（KTD 编号）/ 风险与回滚 / 验收标准；3) 任务拆解必须有 KTD 编号、负责人、依赖关系、验收标准；4) 设计方案必须含架构图或流程图（Mermaid/ASCII）；5) 风险评估必须含回滚策略；6) 引用的现有代码/接口必须真实存在；7) 验收标准必须可量化（性能指标/测试覆盖/功能点）；8) 中文撰写。"
|
||
},
|
||
{
|
||
"path": "**/AGENTS.md",
|
||
"rule": "项目上下文文档专项（AGENTS.md）：1) 规则部分必须可执行（每条规则对应代码可验证点）；2) 技术栈版本必须与 pyproject.toml/package.json 一致；3) 命令必须可复制运行（含正确路径与参数）；4) 架构描述必须与当前代码结构一致（模块映射表、路由表、Agent 层级、专家团队模式）；5) WebSocket 协议消息类型必须与代码中定义一致；6) 配置优先级必须与代码实现一致；7) 约定部分（技能配置路径、专家模板、测试位置）必须真实存在；8) 边界部分必须明确禁止事项。"
|
||
},
|
||
{
|
||
"path": "**/CONCEPTS.md",
|
||
"rule": "领域词汇表专项（CONCEPTS.md）：1) 每个术语必须包含 — 名称（中英）、定义、代码位置、相关术语；2) 术语必须与代码中实际使用一致（类名/枚举值/状态名）；3) 分类清晰（实体/流程/状态概念）；4) 无重复或矛盾术语；5) 中文定义，英文术语保留原文；6) 引用的代码位置必须真实存在。"
|
||
},
|
||
{
|
||
"path": "**/.trae/rules/*.md",
|
||
"rule": "规则文件专项（.trae/rules/）：1) 规则必须明确可执行（非模糊建议）；2) 必须包含正确/错误示例对比；3) 规则之间无冲突；4) 与 AGENTS.md 一致；5) 例外情况必须明确标注；6) 简洁聚焦，单一规则文件解决单一领域问题。"
|
||
},
|
||
{
|
||
"path": "**/README.md",
|
||
"rule": "README 专项：1) 必须包含 — 项目简介 / 快速开始 / 安装步骤 / 基本用法 / 配置说明 / 文档索引 / 贡献指南链接；2) 安装命令必须可复制运行；3) 项目简介必须准确反映当前功能；4) 文档索引链接必须有效；5) License 与版本信息必须准确；6) 徽章（badges）必须有效。"
|
||
}
|
||
]
|
||
}
|