知识库文档审查周期规范

版本: 1.0
生效日期: 2026-04-05
维护者: Nanobot

---

📋 审查周期矩阵

文档类型	审查周期	责任人	审查重点
协议规范 (protocols/)	每季度	Nanobot	协议一致性、版本兼容性
操作指南 (guides/)	每半年	Nanobot	步骤准确性、截图更新
故障排除 (troubleshooting/)	每月	Nanobot	问题复现、解决方案验证
参考资料 (reference/)	每年	Nanobot	外部链接有效性、UI 变化
项目文档 (projects/)	项目结束后归档	Nanobot	完整性、准确性
研究报告 (reports/)	归档后不审查	-	历史资料保留

---

🔍 审查流程

1. 自动扫描（每月 1 日）

# 运行审查脚本
python scripts/scan-docs-health.py

检查项：

• [ ] 外部链接有效性（HTTP 状态码）
• [ ] 内部链接完整性（无 404）
• [ ] Frontmatter Schema 验证
• [ ] 敏感信息扫描（gitleaks）
• [ ] 构建测试（VitePress build）

2. 标记过期文档

过期判定标准：

• 文档内容提及的版本号已过时（如 Python 3.10 → 3.12）
• 外部链接连续 2 次审查失败
• UI 截图与实际界面差异>30%
• 文档标记 [STALE] 超过 3 个月

标记方式：

---
status: stale  # 或 draft/published/archived
last_reviewed: 2026-01-15
review_due: 2026-04-15
---

> [!WARNING] 待审查
> 本文档上次审查时间为 2026-01-15，部分内容可能已过时。

3. 更新或归档

决策树：

文档是否仍有价值？
├─ 是 → 更新内容 → 标记 status: published
├─ 否 → 移至 archives/ → 标记 status: archived
└─ 不确定 → 标记 status: stale → 下季度再评估

---

📊 健康度指标

文档健康评分

计算公式：

健康分 = 100 - (过期文档数 / 总文档数 × 50) - (死链数 / 总链接数 × 30) - (Schema 错误数 × 20)

目标：

• 🟢 优秀：90-100 分
• 🟡 良好：70-89 分
• 🟠 需改进：50-69 分
• 🔴 危险：<50 分

审查覆盖率

计算公式：

审查覆盖率 = 按期审查文档数 / 应审查文档数 × 100%

目标： ≥95%

---

🤖 自动化机制

1. GitHub Actions 定时审查

文件： .github/workflows/monthly-review.yml

name: Monthly Documentation Review

on:
  schedule:
    - cron: '0 2 1 * *'  # 每月 1 日 02:00 UTC

jobs:
  health-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
      
      - name: Install dependencies
        run: npm ci
      
      - name: Build test
        run: npm run build
      
      - name: Check external links
        run: npm run check-links
      
      - name: Schema validation
        run: node scripts/validate-schema.js
      
      - name: Generate health report
        run: python scripts/generate-health-report.py
      
      - name: Upload report
        uses: actions/upload-artifact@v4
        with:
          name: health-report
          path: docs-health-report.md

2. 过期提醒（Feishu）

触发条件： 文档 review_due 日期临近（提前 7 天）

消息模板：

🔔 文档审查提醒

文档：{doc_title}
路径：{doc_path}
到期日期：{review_due}
当前状态：{status}

请及时审查或更新。

---

📝 审查记录

审查日志格式

文件： docs/.review-log.md

## 2026-04-05 审查记录

**审查人:** Nanobot  
**审查范围:** 全部文档  
**健康评分:** 95/100 🟢

### 更新文档
- `guides/cloudflare-access-setup.md` - 更新截图
- `reference/cloudflare-ui-changes-2026.md` - 补充新 UI 变化

### 标记过期
- `reference/old-deployment-guide.md` → status: stale

### 归档文档
- `projects/legacy-migration.md` → 移至 archives/

---

🔗 相关文档

• 文档生命周期管理规范
• 知识关联规范
• V2 协议规范

---

最后审查日期: 2026-04-05
下次审查日期: 2026-05-01
健康评分: 待计算