内容质量审计清单
这个页面用于记录资料库中的内容质量问题,帮助后续持续优化。
它不是普通用户必读页面,而是维护者用来判断:
- 哪些文档需要合并
- 哪些文档需要补证据
- 哪些文档需要补 frontmatter
- 哪些文档需要改成站内链接
- 哪些文档需要改表格格式
- 哪些文档需要补“最小可做版本”
- 哪些导航入口需要更新
当前优先级
| 优先级 | 类型 | 说明 |
|---|---|---|
| P0 | 仓库清理 | 移除误提交的备份目录、构建产物和临时文件 |
| P1 | 入口整理 | 保证首页、按问题查资料、知识库总导航、分类导航层级清晰 |
| P2 | 链接规范 | 把文档中的 docs/...md 仓库路径逐步改为 VitePress 站内链接 |
| P3 | 证据回链 | 给 E3 研究结论补充 OCR、截图或原始资料来源 |
| P4 | 内容合并 | 合并重复报告、重复指南和版本过多的阶段性文档 |
| P5 | 教程增强 | 给实战文档补“最小可做版本、变量设计、广播设计、常见错误” |
待清理内容
| 位置 | 问题 | 建议处理 | 状态 |
|---|---|---|---|
docs/.vitepress.bak.* | 备份目录不应进入仓库 | 删除并加入 .gitignore | 处理中 |
docs/OCR 完整化推进清单.md | 根目录文档过多 | 移动到 OCR资料 | 处理中 |
docs/知识库总索引.md | 根目录文档过多 | 移动到 总索引与导航 | 处理中 |
docs/知识库扩展复盘与完善路线图.md | 根目录文档过多 | 移动到 维护与报告 | 处理中 |
待合并或重构内容
| 范围 | 问题 | 建议处理 | 状态 |
|---|---|---|---|
| OCR资料 | V1/V2/V3 报告较多 | 新增“当前状态与待补清单”,历史报告作为归档 | 待处理 |
| 核心研究/联机相关 | 多个联机指南可能重复 | 建立联机系统阅读导航,明确入门、完全指南、速查卡关系 | 待处理 |
| 导航页 | 多个导航都承担总入口职责 | 明确:首页 → 按问题查资料 → 总导航 → 分类导航 → 具体文档 | 进行中 |
| 维护报告 | AI 建设报告版本较多 | 保留历史,增加当前状态和归档说明 | 待处理 |
待补证据内容
| 文档类型 | 当前问题 | 建议补充 | 状态 |
|---|---|---|---|
| 脚本系统相关专题 | 部分结论为 E3 归纳 | 补充 OCR 或截图来源回链 | 待处理 |
| 项目设计相关指南 | 方法论较多 | 补充“适用前提”和“限制说明” | 待处理 |
| AI/联机/存档等高级专题 | 可能存在推断内容 | 标记 E4 待验证段落 | 待处理 |
| OCR 总结页面 | 历史报告较多 | 建立当前状态页,减少用户迷路 | 待处理 |
待增强教程化内容
| 类型 | 建议增加模块 |
|---|---|
| 项目设计文档 | 最小可做版本、变量设计、广播设计、常见错误 |
| 脚本文档 | 积木使用场景、触发时机、错误案例、调试方法 |
| OCR 资料文档 | 原始内容、人工修正、对应专题、证据等级 |
| 导航文档 | 适合谁、先看什么、不适合谁、下一步去哪 |
表格格式检查
需要重点检查这些类型的内容:
系统 文档 说明误区 后果 正确做法文档 说明 适合阶段变量名 类型 作用广播名 触发方 接收方 作用
如果显示成普通文本,应改为标准 Markdown 表格。
链接规范
推荐使用 VitePress 站内链接:
尽量避免在普通用户阅读页大量使用:
docs/总索引与导航/新手阅读路线.md
仓库路径可以保留在 README 或维护文档中,但普通用户阅读页应优先使用站内链接。
后续维护原则
- 新增重要文档后,必须挂到至少一个导航入口。
- 新增研究结论后,尽量标注证据等级。
- 新增教程文档后,尽量补“最小可做版本”。
- 历史报告不要直接删除,先归档、再建立当前状态页。
- 优先优化高频入口页面,而不是平均修改所有文档。
