docs: 评审整改 P0 文档包(第 12 次评审 79 分失分项)
- 新增 measurement/ 测量协议入口(baseline.md + timing-log.md) - 新增 docs/demo-storyboard.md 演示视频分镜 - README 新增背景与痛点、挂接测量协议/设计文档/分镜链接
This commit is contained in:
@@ -8,9 +8,24 @@ AI 驱动的代码审查与规范检查一体化 VS Code 插件。集成 ESLint
|
||||
|
||||
「净码特工 (Code Purifier)」是一款面向企业级多语言代码库的一体化代码审查与规范检查 VS Code 扩展。它将传统静态检查(ESLint、Stylelint、PMD、SQLFluff)与 AI 大模型审查深度融合,覆盖 JavaScript、TypeScript、Java、JSP、HTML、CSS、SQL、PL/SQL 八类语言,提供一键审查、方法级审查、AI 自动修复与修复预览、报告导出、自定义规则导入等能力,并内置 Webview 面板实现"配置—审查—修复—导出"的闭环体验。
|
||||
|
||||
> 完整设计见 [DESIGN.md](DESIGN.md),实现时间线见 [docs/2026-08-27-implementation-timeline.md](docs/2026-08-27-implementation-timeline.md)。
|
||||
|
||||
## 背景与痛点
|
||||
|
||||
企业多语言混合工程(典型如运营商城域后台、金融核心等遗留系统)中,Java、JSP、JavaScript/TypeScript、CSS、SQL 长期共存,代码审查面临以下痛点,本插件逐一给出对应方案:
|
||||
|
||||
| 痛点 | 插件方案 |
|
||||
|---|---|
|
||||
| Linter 报错是英文机器语言,非母语开发者阅读成本高 | AI 将静态诊断翻译为输出语言(中/英/日)并附加修复建议 |
|
||||
| 静态规则覆盖不了语义级安全漏洞、逻辑错误、设计缺陷 | LLM 深度审查通道专注安全/逻辑/性能/设计四类增量发现,且不重复静态结果 |
|
||||
| 团队私有编码规范无法进入通用 linter | YAML 自定义规则:自然语言描述 + AI 语义判定 + 热加载 |
|
||||
| 发现问题后修复仍靠人工逐条处理 | 分级修复闭环:原生 fix 优先 → AI 修复兜底 → diff 预览两步确认写入 |
|
||||
|
||||
> 详细场景与完整痛点-方案映射见 [DESIGN.md](DESIGN.md) §1。
|
||||
|
||||
## 效果总结(核心指标摘要)
|
||||
|
||||
> 数据来源:A3 提效对比实验(23 个多语言样例,`data/efficiency-samples/`)。「提效后」= 插件静态分析实测(`tests/measure/results/a3-plugin-results.json`,可复现 `node tests/measure/measure-plugin-samples.mjs`);「基线」= 3 名不同经验等级审查人使用人工审核工具逐文件计时记录问题(`tests/measure/results/manual-review-*.json`);聚合对比见 `tests/measure/performance-comparison.md` 与 `tests/measure/results/a3-comparison.json`。
|
||||
> 数据来源:A3 提效对比实验(23 个多语言样例,`data/efficiency-samples/`)。「提效后」= 插件静态分析实测(`tests/measure/results/a3-plugin-results.json`,可复现 `node tests/measure/measure-plugin-samples.mjs`);「基线」= 3 名不同经验等级审查人使用人工审核工具逐文件计时记录问题(`tests/measure/results/manual-review-*.json`);聚合对比见 `tests/measure/performance-comparison.md` 与 `tests/measure/results/a3-comparison.json`。测量协议详见 [measurement/baseline.md](measurement/baseline.md)(人工基线)与 [measurement/timing-log.md](measurement/timing-log.md)(计时日志与可重演命令)。
|
||||
|
||||
| 指标 | 基线(人工审查,3 人均值) | 提效后(插件静态分析) | 提升幅度 |
|
||||
|------|---------------------------|------------------------|----------|
|
||||
@@ -178,4 +193,4 @@ Webview 资源在编译/打包时自动复制到 `out/webview/`,随插件加
|
||||
|
||||
## 演示视频
|
||||
|
||||
演示视频(`docs/demo.mp4`,≤5 分钟:完整工作流 + IDE 集成效果 + 异常处理)**进行中**,将在后续提交中补齐。
|
||||
演示视频(`docs/demo.mp4`,≤5 分钟:完整工作流 + IDE 集成效果 + 异常处理)**进行中**,将在后续提交中补齐。分镜脚本见 [docs/demo-storyboard.md](docs/demo-storyboard.md)(三段式:完整工作流 / IDE 集成 / 异常处理)。
|
||||
|
||||
Reference in New Issue
Block a user