文档治理机制

本文档说明 OpenClaw 中文站的文档治理机制，确保与官方保持同步的同时，为中文社区提供有价值增强内容。

📊 文档分层策略

官方同步层（优先级 P0）

这些目录严格遵循官方文档，确保内容与官方保持一致：

目录	同步策略	更新频率
`start/`	官方优先，实时同步	每周
`install/`	官方优先	每月
`channels/`	官方优先 + 本地化示例	每周
`providers/`	官方优先 + 国产模型补充	每周
`gateway/`	官方优先	每月
`tools/`	官方优先	每月
`cli/`	官方优先	每月
`platforms/`	官方优先	每月
`reference/`	官方优先	每月

同步原则：

功能描述以官方为准
配置示例保持与官方一致
仅做必要的中文本地化

社区增强层（优先级 P1）

这些目录提供面向中文社区的增强内容，可以超越官方：

目录	定位	维护者
`guides/`	实战指南、最佳实践	社区
`agent/`	Agent 调教、工作区示例	社区
`deep-dive/`	实现剖析、原理导读	社区
`providers/china.md`	国产模型专题	社区
`providers/failover.md`	故障转移专题	社区

增强原则：

明确标注"社区增强"标识
保持与官方能力不冲突
优先解决中文用户痛点

🔄 同步工作流

定期同步（每周）

# 1. 拉取官方最新文档
cd /path/to/official-repo
git pull origin main

# 2. 运行对比脚本
cd /Volumes/data/work/github/openclawcn
./compare_docs.sh

# 3. 检查差异
cat .cache/compare_docs/official_en_missing_public.txt

# 4. 同步缺失内容
# - 翻译新增页面
# - 更新配置示例
# - 检查链接有效性

# 5. 验证构建
cd site && hugu --cleanDestinationDir

# 6. 提交变更
git add .
git commit -m "sync: 同步官方文档更新 $(date +%Y%m%d)"

自动化检查

每次 Pull Request 自动运行：

# .github/workflows/docs-check.yml
name: 文档同步检查
on: [pull_request]
jobs:
  check-sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: 运行对比脚本
        run: ./compare_docs.sh
      - name: 检查公开缺口
        run: |
          if [ $(cat .cache/compare_docs/official_en_missing_public.txt | wc -l) -gt 0 ]; then
            echo "发现公开文档缺口"
            exit 1
          fi

📝 内容规范

官方同步层规范

标题保持一致

# ❌ 错误
# 开关配置

# ✅ 正确
# Gateway Configuration

代码示例同步

// 与官方示例保持一致的格式和字段
{
  gateway: {
    // ...
  },
}

链接使用相对路径

# ✅ 正确
[配置参考](/zh-cn/docs/reference/config.md)

# ❌ 错误
[配置参考](https://openclaw.dev/docs/reference/config.md)

社区增强层规范

添加增强标识

---
title: "家庭服务器部署"
description: "面向中文用户的实战指南"
tags: ["community", "指南"]
---

说明定位

> 本文是社区增强内容，基于 OpenClaw 官方能力编写。
> 如有疑问，请先查阅[官方文档](/zh-cn/docs/)。

明确适用场景

## 适用场景

本文适用于以下场景：
- 家庭网络环境
- 国内网络环境
- 个人或小团队使用

## 局限性

- 某些高级功能可能需要额外配置
- 性能取决于硬件配置

🔍 质量保障

自动化检查

# 检查链接有效性
find site/content -name "*.md" -exec grep -H "\]\(" {} \; | while read line; do
  # 提取并检查链接
done

# 检查图片引用
find site/content -name "*.md" -exec grep -H "!\[" {} \;

# 检查代码块语法
# 确保所有代码块都有语言标记

人工审核清单

标题层级正确（最多 3 级）
代码示例可运行
链接全部有效
图片清晰且大小合理
中文表达自然流畅
术语翻译一致

🚫 禁止事项

官方同步层禁止

❌ 擅自修改官方功能描述
❌ 添加未经官方验证的功能
❌ 更改配置字段名称
❌ 删除官方文档内容
❌ 发布与官方相矛盾的信息

社区增强层禁止

❌ 伪装成官方内容
❌ 推广商业产品
❌ 包含恶意代码
❌ 侵犯版权

📧 反馈机制

文档问题反馈

发现文档问题时，按以下优先级处理：

优先级	类型	处理时间	负责方
P0	官方同步错误	24 小时	维护者
P1	社区内容错误	72 小时	社区
P2	翻译优化	1 周	社区
P3	内容建议	随时	社区

反馈渠道

GitHub Issues：提交问题
Pull Request：直接改进文档
Discussions：讨论改进建议

📈 指标监控

定期监控以下指标：

# 文档覆盖率
./compare_docs.sh | grep "official en missing public"

# 链接健康度
# 使用工具检查所有外部链接

# 用户反馈
# 统计 Issues 和 PRs 中文档相关的数量

🎯 目标

✅ 官方公开文档覆盖率：100%
✅ 链接有效率：> 99%
✅ 文档更新延迟：< 7 天
✅ 用户满意度：> 90%

🔗 相关文档

CI 流水线