知识库审查 jony19830201/dsh-knowledge-review

DSH Knowledge Review — 基于 LLM 规范的文档审查

npm MIT DSH

DeepSeek Harness 团队知识库插件 — 上传文档、用可配置的 LLM 规范进行审查、跨项目追踪问题。

上传文档，选择审查规范，一键获得评分结果和可执行的修改建议 | 一行命令安装 | SQLite FTS5 全文搜索 | /knowledge-review 独立 Web 页面

亮点 | 快速开始 | 功能 | 配置 | 常见问题

🌐 English | 中文

基于： DeepSeek Harness — 插件化的 Agent 运行时。文档转换由 markitdown 提供。

亮点

- 上传即审查。 拖入 .md、.docx 或 .pdf 文件，选择文档类型，一键运行审查。引擎根据配置的规范对文档内容进行审查，返回带评分的 Issue 和建议。
- 可配置的审查规范。 每个规范是一个独立的 SKILL.md 文件，定义审查标准、严重级别和评分规则。在 cordis.patch.yml 中将规范映射到文档类型，插件自动匹配。
- 全文搜索。 SQLite FTS5 索引所有文档内容。跨项目按关键字搜索，快速定位相关文档。
- 审查历史与差异对比。 每次审查结果都保存原始内容、评分明细、Issue 列表和修改建议。支持并排对比历史审查，追踪文档质量变化。
- 项目组管理。 以树形结构组织文档到项目组中，贴合团队实际知识管理方式。
- 独立 Web 页面。 /knowledge-review 提供完整的三栏界面：左侧项目树、中间文档预览、右侧审查结果。无需进入聊天上下文。

快速开始

1. 安装

dsh plugin --profile web add @deepseek-ai/dsh-knowledge-review

或从 GitHub 安装：

cd ~/.dsh/profiles/web
pnpm add github:jony19830201/dsh-knowledge-review

2. 安装 markitdown

pip install markitdown

3. 配置

在 profile 的 cordis.patch.yml 中添加：

- insert:
- id: knowledge-review
name: '@deepseek-ai/dsh-knowledge-review'
config:
dbPath: ~/.dsh/knowledge-review.sqlite
fileStorePath: ~/.dsh/knowledge-review/files/
provider: deepseek-official
model: deepseek-v4-flash
reviewSkills:
- name: 需求质量审查 path: /path/to/review-requirement-quality docTypes:
- 需求 description: 以功能清单为基准审查中文需求文档 defaultDocTypes:
- 需求
- 设计
- 测试用例
- 场景码

完整注释示例见 cordis.example.yml。

4. 重启并打开

重启 Web Profile，然后在浏览器中打开 /knowledge-review。左侧导航栏也会增加知识库入口。

效果预览

主界面 — 项目树、文档预览和审查结果

主界面：左侧项目树，中间文档预览，右侧审查结果

_三栏布局：浏览项目、预览文档、并排查看审查结果。_

上传对话框

上传对话框，支持文档类型选择和规范匹配

_上传文档，选择类型，自动匹配对应的审查规范。_

审查详情

审查详情页，包含评分、Issue 列表和修改建议

_每次审查展示评分、按严重级别分类的 Issue、位置标注和可执行的修改建议。_

功能

| 功能 | 说明 |
| 文档上传 | 支持 Markdown、DOCX、PDF，拖拽或文件选择器上传 |
| 自动转换 | DOCX 和 PDF 通过 markitdown 转为 Markdown |
| 项目组管理 | 树形结构组织项目，支持可配置的文档类型 |
| 规范审查 | 每种文档类型映射到审查规范，引擎自动匹配执行 |
| 评分结果 | 审查返回评分、结构化 Issue 列表（含严重级别、位置、建议） |
| FTS5 全文搜索 | 跨文档全文搜索，关键字高亮 |
| 审查历史 | 历史审查记录保存，支持差异对比 |
| 独立页面 | /knowledge-review — 三栏布局：项目树、预览、结果 |
| 侧边栏入口 | 集成到 Harness Web 应用左侧导航 |

工作原理

上传 → markitdown → Markdown → 审查引擎 → LLM（规范）→ 评分报告 │ │ └── SQLite (FTS5) ←──────────────────────────────────┘

1. 上传： 用户上传文档（.md、.docx、.pdf）并选择文档类型。
2. 转换： DOCX 和 PDF 通过 markitdown 转为 Markdown，原始文件保留。
3. 存储： 文档内容存入 SQLite，启用 FTS5 全文索引。
4. 审查： 审查引擎加载匹配的规范，组装提示词，发送给配置的 LLM。
5. 报告： LLM 返回结构化 JSON 报告，包含评分、分类 Issue、位置和建议。结果存储并在界面中展示。

配置

| 配置键 | 类型 | 说明 |
| dbPath | string | SQLite 数据库路径（如 ~/.dsh/knowledge-review.sqlite） |
| fileStorePath | string | 上传文件存储目录（如 ~/.dsh/knowledge-review/files/） |
| provider | string | DSH 中 LLM provider 名称（如 deepseek-official） |
| model | string | 模型名称（如 deepseek-v4-flash） |
| reviewSkills | array | 审查规范配置列表 |
| reviewSkills[].name | string | 规范显示名称 |
| reviewSkills[].path | string | 规范 SKILL.md 所在目录路径 |
| reviewSkills[].docTypes | string[] | 该规范适用的文档类型 |
| reviewSkills[].description | string | 规范审查内容简述 |
| defaultDocTypes | string[] | 默认文档类型选项（如 需求、设计、测试用例） |

常见问题

| 问题 | 解决方法 |
| markitdown 未找到 | 运行 pip install markitdown 并确认在 PATH 中 |
| 审查返回空或报错 | 检查规范的 SKILL.md 是否在配置的路径下，LLM provider 是否配置正确 |
| 上传失败 | 确认 fileStorePath 可写，DOCX/PDF 需安装 markitdown |
| 知识库标签不显示 | 添加插件后重启 Web Profile |
| 搜索无结果 | 确认已上传文档，FTS5 索引默认启用 |

开发

从源码构建

git clone https://github.com/jony19830201/dsh-knowledge-review.git
cd dsh-knowledge-review
pnpm install
pnpm run build
pnpm run test

构建产物输出到 lib/，包含 host 插件、client 插件和独立 Web 应用。

项目结构

src/
index.ts # Host 插件：REST API、SQLite、审查引擎 db.ts # SQLite 数据库（含 FTS5） review.ts # LLM 审查引擎 client/ index.ts # Client 插件入口 sidebar-entry.ts # 左侧导航注入 kb-view.ts # 应用内知识库视图 web/ app.ts # 独立 Web 应用入口 api.ts # 客户端 API 辅助 views/ main.ts # 主视图：项目树 + 文档预览 upload.ts # 上传对话框 report.ts # 审查详情和 Issue 列表 tests/ review.spec.ts # 审查引擎测试 fixtures/ review-skill/ # 测试规范桩

License

MIT © The dsh-knowledge-review Authors

上游项目： DeepSeek Harness · markitdown