RailWise KB已发布
文档审核流程
RailWise知识库文档审核流程规范，涵盖自动检查、初审、技术审核、质量审核及发布各阶段的标准和要求。
community-guide
文档审核流程
Section titled “文档审核流程”审核流程总览
Section titled “审核流程总览”┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐│ 投稿提交 │ → │ 自动检查 │ → │ 初审 │ → │ 技术审核 │ → │ 质量审核 │ → │ 发布上线 ││ │ │ (即时) │ │ (1-2天) │ │ (2-3天) │ │ (1-2天) │ │ (即时) │└──────────┘ └──────────┘ └──────────┘ └──────────┘ └──────────┘ └──────────┘ ↑ ↓ └──────────────────────── 反馈修改 ← 审核不通过 ───────────────────────┘阶段一：自动检查
Section titled “阶段一：自动检查”投稿提交后，系统自动执行以下检查：
| 检查项 | 检查内容 | 通过标准 | 失败处理 |
|---|---|---|---|
| 格式检查 | Markdown语法 | 无语法错误 | 标记格式问题 |
| Frontmatter | YAML格式 | 必需字段完整 | 标记缺失字段 |
| 链接检查 | 内部链接 | 所有链接有效 | 标记无效链接 |
| 图片检查 | 图片引用 | 图片存在且可访问 | 标记缺失图片 |
| 敏感词检查 | 敏感内容 | 无敏感词 | 标记敏感内容 |
| 重复检查 | 内容重复 | 与现有文档重复率<30% | 标记重复内容 |
自动检查报告
Section titled “自动检查报告”## 自动检查报告
| 检查项 | 状态 | 详情 ||--------|------|------|| Markdown格式 | ✅/❌ | {详情} || YAML Frontmatter | ✅/❌ | {详情} || 内部链接 | ✅/❌ | {详情} || 图片引用 | ✅/❌ | {详情} || 敏感词 | ✅/❌ | {详情} || 重复检查 | ✅/❌ | {详情} |
**总体状态**: {通过/需修改/拒绝}阶段二：初审
Section titled “阶段二：初审”社区运营团队
| 审核项 | 审核要点 | 通过标准 |
|---|---|---|
| 主题相关性 | 内容是否与知识库主题相关 | 与工程监测、RailWise产品相关 |
| 内容完整性 | 文档结构是否完整 | 包含必要章节 |
| 格式规范性 | 是否符合格式要求 | 符合模板规范 |
| 语言质量 | 语言表达是否清晰 | 无明显语病 |
| 版权合规 | 是否涉及版权问题 | 原创或已获授权 |
| 结果 | 含义 | 后续操作 |
|---|---|---|
| 通过 | 进入技术审核 | 分配给技术审核员 |
| 需修改 | 有小问题需修正 | 反馈修改意见，修改后重新初审 |
| 拒绝 | 不符合基本要求 | 说明拒绝原因，关闭投稿 |
阶段三：技术审核
Section titled “阶段三：技术审核”技术专家团队（根据文档类型分配）
| 审核项 | 审核要点 | 通过标准 |
|---|---|---|
| 技术准确性 | 技术内容是否正确 | 无技术错误 |
| 方案可行性 | 方案是否可行 | 经过实践验证或理论可行 |
| 数据合理性 | 数据是否合理 | 数据范围合理，标注来源 |
| 标准合规性 | 是否符合标准规范 | 引用标准正确 |
| 产品一致性 | 与产品功能是否一致 | 描述与产品实际一致 |
技术审核结果
Section titled “技术审核结果”| 结果 | 含义 | 后续操作 |
|---|---|---|
| 通过 | 进入质量审核 | 分配给质量审核员 |
| 需修改 | 有技术问题需修正 | 反馈技术意见，修改后重新技术审核 |
| 拒绝 | 存在严重技术问题 | 说明拒绝原因，关闭投稿 |
阶段四：质量审核
Section titled “阶段四：质量审核”资深技术编辑
| 审核项 | 审核要点 | 通过标准 |
|---|---|---|
| 结构质量 | 文档结构是否合理 | 逻辑清晰，层次分明 |
| 表达质量 | 表达是否准确简洁 | 无冗余，无歧义 |
| 图表质量 | 图表是否清晰有用 | 图表清晰，标注完整 |
| 引用质量 | 引用是否规范 | 引用格式正确，来源可靠 |
| 一致性 | 与知识库整体风格一致 | 术语、格式一致 |
质量审核结果
Section titled “质量审核结果”| 结果 | 含义 | 后续操作 |
|---|---|---|
| 通过 | 发布上线 | 合并到主分支，发布 |
| 需修改 | 有质量问题需修正 | 反馈修改意见，修改后重新质量审核 |
| 拒绝 | 质量不达标 | 说明拒绝原因，关闭投稿 |
阶段五：发布上线
Section titled “阶段五：发布上线”- 合并到主分支
- 生成静态站点
- 部署到CDN
- 更新搜索索引
- 通知贡献者
- 文档页显示作者信息
- 贡献者积分发放
- 社区公告（优秀文档）
| 阶段 | 预计时间 | 备注 |
|---|---|---|
| 自动检查 | 即时 | 系统自动 |
| 初审 | 1-2个工作日 | 工作日 |
| 技术审核 | 2-3个工作日 | 需技术专家 |
| 质量审核 | 1-2个工作日 | 需资深编辑 |
| 总计 | 4-7个工作日 | 不含修改时间 |
对于紧急或重要的投稿，可申请加急审核。加急审核将优先处理，预计2-3个工作日完成。
## 审核反馈
**审核阶段**: {初审/技术审核/质量审核}**审核结果**: {通过/需修改/拒绝}**审核时间**: {日期}
### 审核意见
{总体评价}
### 具体问题
| 序号 | 位置 | 问题 | 建议 ||------|------|------|------|| 1 | {章节} | {问题描述} | {修改建议} || 2 | {章节} | {问题描述} | {修改建议} |
### 修改要求
- {修改要求1}- {修改要求2}
### 修改期限
请于 {日期} 前完成修改并重新提交。如对审核结果有异议，可通过以下方式申诉：
- 在投稿页面点击 “申诉”
- 填写申诉理由
- 提交申诉
申诉将在3个工作日内处理，由更高级别的审核员重新评估。