RailWise KB已发布
内容质量标准
RailWise知识库内容质量标准，定义文档质量等级、评分维度、检查清单及优秀文档示例。
community-guide
内容质量标准
Section titled “内容质量标准”文档质量分为四个等级：
| 等级 | 分数 | 说明 | 处理方式 |
|---|---|---|---|
| ⭐⭐⭐⭐⭐ 优秀 | 90-100 | 内容全面、准确、结构清晰、表达优秀 | 优先推荐、首页展示 |
| ⭐⭐⭐⭐ 良好 | 75-89 | 内容完整、基本准确、结构合理 | 正常发布 |
| ⭐⭐⭐ 合格 | 60-74 | 内容基本完整，有小问题 | 需修改后发布 |
| ⭐⭐ 不合格 | <60 | 内容不完整或有严重问题 | 拒绝发布 |
1. 内容准确性（30分）
Section titled “1. 内容准确性（30分）”| 评分项 | 分值 | 评分标准 |
|---|---|---|
| 技术准确性 | 15 | 技术内容正确，无错误 |
| 数据准确性 | 10 | 数据真实可靠，标注来源 |
| 标准引用 | 5 | 标准引用正确，版本有效 |
评分细则：
- 15分：技术内容完全正确，经专家验证
- 10分：技术内容基本正确，有小瑕疵
- 5分：技术内容有部分错误
- 0分：技术内容有严重错误
2. 内容完整性（25分）
Section titled “2. 内容完整性（25分）”| 评分项 | 分值 | 评分标准 |
|---|---|---|
| 结构完整 | 10 | 包含必要章节，逻辑清晰 |
| 信息完整 | 10 | 关键信息无遗漏 |
| 示例充分 | 5 | 有足够的示例和说明 |
评分细则：
- 10分：结构完整，包含所有必要章节
- 7分：结构基本完整，缺少次要章节
- 4分：结构不完整，缺少重要章节
- 0分：结构严重缺失
3. 表达质量（20分）
Section titled “3. 表达质量（20分）”| 评分项 | 分值 | 评分标准 |
|---|---|---|
| 语言清晰 | 10 | 表达清晰，无歧义 |
| 术语规范 | 5 | 术语使用规范统一 |
| 格式规范 | 5 | Markdown格式规范 |
评分细则：
- 10分：表达清晰简洁，专业准确
- 7分：表达基本清晰，有小问题
- 4分：表达有歧义或冗余
- 0分：表达混乱，难以理解
4. 实用价值（15分）
Section titled “4. 实用价值（15分）”| 评分项 | 分值 | 评分标准 |
|---|---|---|
| 可操作性 | 8 | 步骤清晰，可操作 |
| 场景覆盖 | 7 | 覆盖常见场景和边界情况 |
评分细则：
- 8分：步骤详细，可直接操作
- 5分：步骤基本清晰，需补充
- 2分：步骤模糊，难以操作
- 0分：无可操作性
5. 附加价值（10分）
Section titled “5. 附加价值（10分）”| 评分项 | 分值 | 评分标准 |
|---|---|---|
| 创新性 | 5 | 有独特见解或创新方法 |
| 可视化 | 5 | 图表、截图丰富清晰 |
质量检查清单
Section titled “质量检查清单”内容准确性检查
Section titled “内容准确性检查”- 技术内容经过验证，无错误
- 数据有来源或标注为“典型值”
- 标准引用正确，版本号准确
- 产品功能描述与实际情况一致
- 命令和代码可执行，已验证
内容完整性检查
Section titled “内容完整性检查”- 包含YAML Frontmatter，字段完整
- 有清晰的标题和概述
- 有适用场景说明
- 有操作步骤或方法说明
- 有注意事项和警告提示
- 有相关文档链接
- 有AI语义标签
表达质量检查
Section titled “表达质量检查”- 语言简洁，无冗余
- 术语使用规范统一
- 标题层级清晰（H1-H4）
- 表格、代码块使用恰当
- 提示框（tip/warning/info）使用恰当
- 无错别字和语法错误
实用价值检查
Section titled “实用价值检查”- 步骤详细，可操作
- 有具体的示例
- 覆盖常见场景
- 有故障排查或常见问题
- 有课后练习或思考题（教程类）
附加价值检查
Section titled “附加价值检查”- 有清晰的图表或截图
- 有独特的见解或经验
- 有最佳实践建议
- 有改进建议或展望
优秀文档示例
Section titled “优秀文档示例”示例一：技术文档
Section titled “示例一：技术文档”文档: CLI快速入门 质量等级: ⭐⭐⭐⭐⭐ 亮点:
- 结构完整，从安装到首条命令
- 示例具体，命令可直接执行
- 包含故障排查和常见问题
- 格式规范，提示框使用恰当
示例二：案例文档
Section titled “示例二：案例文档”文档: 绕城高速管廊盾构侧穿3号线案例 质量等级: ⭐⭐⭐⭐⭐ 亮点:
- 项目信息完整，背景清晰
- 监测方案详细，数据表格规范
- 预警处置有具体事件
- 经验总结有价值
示例三：教程文档
Section titled “示例三：教程文档”文档: 视频教程：CLI安装与首条命令 质量等级: ⭐⭐⭐⭐⭐ 亮点:
- 步骤详细，有截图占位符
- 包含前置知识和学习目标
- 有常见问题解答
- 有课后练习
常见质量问题
Section titled “常见质量问题”问题一：内容不完整
Section titled “问题一：内容不完整”表现: 缺少必要章节，如没有注意事项或相关文档链接 解决: 对照检查清单补充缺失内容
问题二：表达不清晰
Section titled “问题二：表达不清晰”表现: 语言冗余，术语不统一，有歧义 解决: 精简语言，统一术语，明确表达
问题三：示例不足
Section titled “问题三：示例不足”表现: 只有理论描述，没有具体示例 解决: 添加具体的命令、代码、数据示例
问题四：格式不规范
Section titled “问题四：格式不规范”表现: Markdown格式错误，标题层级混乱 解决: 使用Markdown编辑器检查格式
质量提升建议
Section titled “质量提升建议”- 参考优秀文档：学习优秀文档的结构和表达方式
- 使用模板：使用官方模板确保结构完整
- 同行评审：投稿前请同事或朋友预审
- 工具辅助：使用Markdown编辑器、拼写检查工具
- 持续改进：根据审核反馈不断改进