# DocQuality

**Repository Path**: linengier/DocQuality

## Basic Information

- **Project Name**: DocQuality
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-27
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# DocQuality · 智能文档质量审查平台

**像和专家对话一样，让 AI 在几十秒内完成一份文档的质量审查**

上传文档 · 描述需求 · 选择规则 · AI 深度审查 · 一键导出报告

[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://github.com/jitOffice/DocQuality/blob/main/LICENSE)
[![React](https://img.shields.io/badge/React-18-61dafb.svg?logo=react)](https://react.dev)
[![NestJS](https://img.shields.io/badge/NestJS-10-e0234e.svg?logo=nestjs)](https://nestjs.com)
[![TypeScript](https://img.shields.io/badge/TypeScript-5-3178c6.svg?logo=typescript)](https://www.typescriptlang.org)
[![Vite](https://img.shields.io/badge/Vite-5-646cff.svg?logo=vite)](https://vitejs.dev)
[![GitHub Stars](https://img.shields.io/github/stars/jitOffice/DocQuality?style=social)](https://github.com/jitOffice/DocQuality)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/jitOffice/DocQuality/pulls)

[项目简介](#项目简介) · [核心特性](#核心特性) · [应用场景](#应用场景) · [快速开始](#快速开始) · [技术栈](#技术栈) · [常见问题](#常见问题-faq) · [友情链接](#友情链接)

</div>

---

## 项目简介

**DocQuality** 是一款开源、可私有化部署的 **AI 智能文档质量审查平台**。它把传统的"上传—等待—看结果"的工具式流程，重构为 **对话式 AI 审查体验**：你只需上传一份 Word 文档，用一句日常语言描述审查需求（例如"重点检查合同里的责任条款是否缺失"），DocQuality 就会结合 **规则引擎** 与 **大语言模型** 从格式规范、合规风险、内容一致性三大维度进行深度审查，并以可视化时间线实时汇报进展，最终给出量化评分、问题清单与修改建议。

无论是合同、公文、报告还是招投标文档，DocQuality 都能帮助你在正式发出前发现潜在风险，让文档质量审查从"靠经验、靠人工"走向"靠 AI、靠标准"。

> 本项目由 [JitWord 协同 AI 文档](https://jitword.com) 团队提供技术支持，文档解析能力基于 JitWord 在线服务。

## 核心特性

### 对话式 AI 智能审查
- 类 ChatGPT 的对话界面：在对话中上传文档、描述需求、选择规则，一次发送即开始审查
- 自然语言需求直达 AI 提示词，让大模型围绕你关心的重点进行审查
- 审查过程实时可视化：接收文档 → 解析结构 → 逐项检查 → AI 深度分析，每一步进展清晰可见
- AI 分析阶段提供动态进度反馈（实时计时 + 阶段提示），长耗时任务不再"黑盒"等待

### 三维度质量审查引擎
- **格式规范**：标题层级、编号、标点、排版一致性
- **合规性**：敏感信息、法律风险表述、必备条款、占位符检测
- **内容一致性**：术语统一、逻辑连贯、前后矛盾、重复冗余
- 量化评分体系：百分制总分 + 优秀/良好/一般/较差四级评定 + 三维度得分拆解

### 人人可用的规则管理
- **规则模板库**：内置广告营销合规、隐私信息保护、合同法律审查等 6 大场景模板，一键即用
- **关键词优先**：不懂正则也能配规则，输入关键词即可（如"机密""绝密"），并支持实时命中测试
- **正则高级模式**：为技术用户保留完整的正则表达式能力
- 预设规则开箱即用，自定义规则灵活扩展，支持规则的导入 / 导出 / 二次编辑

### 多模型 AI 支持
- 开箱支持 **DeepSeek、通义千问（Qwen）、Kimi（Moonshot）、OpenAI** 等主流服务商
- 兼容任意 OpenAI 协议的自定义服务，可自由配置 Base URL 与模型
- 内置连接测试，一键校验 API Key 可用性

### 报告与协作
- 审查报告一键导出为 **HTML / PDF / Word** 三种格式
- 审查历史可追溯、可对比、可预览原文档、支持 CSV 导出
- 基于 JitWord 的在线文档预览，无需下载即可核对原文

### 私有化与数据安全
- 支持完全本地化部署，文档与审查数据存储在本地 SQLite，敏感数据不出内网
- 账号体系与 JitWord 开放平台互通，登录状态持久化，刷新不丢失

## 应用场景

| 场景 | 价值 |
| --- | --- |
| 合同审查 | 自动检测责任条款缺失、占位符未填充、绝对化用语等法律风险 |
| 公文校对 | 检查格式规范、编号层级、标点与排版一致性 |
| 招投标文档 | 扫描敏感信息泄露、必备条款完整性与前后一致性 |
| 营销文案合规 | 识别广告法禁用的极限词与违规表述 |
| 报告质检 | 发现术语不统一、逻辑矛盾与重复冗余 |

## 快速开始

### 环境要求
- Node.js 18+
- pnpm 8+

### 安装与运行

```bash
# 1. 克隆仓库
git clone https://github.com/jitOffice/DocQuality.git
cd DocQuality

# 2. 安装依赖（Monorepo，自动安装 client 与 server）
pnpm install

# 3. 配置后端环境变量
#    编辑 server/.env，填入 JitWord API 地址与 Token（用于文档解析）

# 4. 同时启动前端与后端
pnpm dev
```

启动后访问：
- 前端界面：http://localhost:3000
- 后端接口：http://localhost:4000

也可分别启动：`pnpm dev:client`（前端）、`pnpm dev:server`（后端）。

### 开始你的第一次审查
1. 注册 / 登录（账号与 JitWord 开放平台互通）
2. 进入「智能审查」，点击回形针上传一份 Word 文档
3. 用一句话描述需求，例如"请重点检查隐私信息泄露"，按 Enter 发送
4. 等待 AI 实时汇报审查进展，查看评分与问题清单
5. 点击「查看完整报告」或导出 HTML / PDF / Word

## 技术栈

| 层 | 技术 |
| --- | --- |
| 前端 | React 18 · TypeScript · Vite · TailwindCSS · Zustand · React Router v6 · lucide-react |
| 后端 | NestJS · TypeORM · SQLite (better-sqlite3) · @nestjs/config · Axios |
| 工程化 | pnpm workspace Monorepo · concurrently |
| AI | OpenAI 兼容协议（DeepSeek / 通义千问 / Kimi / OpenAI / 自定义） |
| 文档解析 | JitWord 在线结构化解析服务 |

## 项目结构

```
DocQuality/
├── client/                 # 前端（Vite + React）
│   └── src/
│       ├── features/       # 业务页面（智能审查 / 规则 / 历史 / 报告 / 设置）
│       ├── components/     # 通用组件（下拉 / 预览 / GitHub 按钮 / 联系弹窗）
│       ├── api/            # 接口封装
│       └── stores/         # Zustand 状态
├── server/                 # 后端（NestJS）
│   └── src/
│       ├── modules/        # 领域模块（document / review / rule / history / report / ai / settings / auth）
│       └── database/       # TypeORM 实体
└── package.json            # Monorepo 根脚本
```

## 常见问题 FAQ

**DocQuality 是什么？**
DocQuality 是一款开源的智能文档质量审查平台，通过对话式 AI 交互，结合规则引擎与大语言模型，从格式、合规、一致性三个维度审查 Word 文档并生成量化报告。

**支持哪些文档格式？**
目前支持 `.docx` 格式的 Word 文档，文档由 JitWord 在线服务进行结构化解析。

**支持哪些 AI 模型？**
开箱支持 DeepSeek、通义千问（Qwen）、Kimi（Moonshot）、OpenAI，并兼容任意遵循 OpenAI 协议的服务，可自定义 Base URL 与模型名称。

**不懂技术也能自定义审查规则吗？**
可以。规则管理采用"关键词优先"设计，只需输入关键词（如"机密""绝密"）即可创建规则并实时测试命中效果；同时提供规则模板库一键套用，技术用户还可切换到正则高级模式。

**审查结果可以导出吗？**
可以，支持导出为 HTML、PDF、Word 三种格式，审查历史还支持 CSV 导出与原文档在线预览。

**数据安全吗？是否支持私有化部署？**
支持完全本地化部署，文档与审查数据存储在本地 SQLite 数据库中，敏感数据无需上传第三方，适合对数据安全要求高的团队。

**DocQuality 是免费的吗？**
是的，DocQuality 基于 GPL-3.0 协议开源，可免费使用与二次开发。

## 友情链接

- [JitWord 协同 AI 文档](https://jitword.com) —— DocQuality 的文档解析与在线预览能力由 JitWord 提供，JitWord 是一款面向团队的协同 AI 文档工具，支持多人在线协作编辑与 AI 写作辅助。
- [JitWord 开放平台](https://next.jitword.com) —— 注册 JitWord 账号后即可与 DocQuality 账号互通，直接使用文档解析服务。

> 欢迎交换友链：如果你的项目也与文档、AI 或效率工具相关，欢迎通过「联系我们」或提交 Issue 与我们交流。

## 参与贡献

我们欢迎任何形式的贡献：提交 Bug、提出新功能建议、改进文档或贡献代码。

1. Fork 本仓库并创建特性分支：`git checkout -b feature/your-feature`
2. 提交改动：`git commit -m "feat: 描述你的改动"`
3. 推送并发起 Pull Request

## 许可证

DocQuality 采用 [GPL-3.0](https://github.com/jitOffice/DocQuality/blob/main/LICENSE) 协议开源。

---

<div align="center">

如果 DocQuality 对你有帮助，欢迎点亮右上角的 **Star** 支持我们。

GitHub：https://github.com/jitOffice/DocQuality

</div>