RailWise KB已发布
RailWise 知识库内容质量标准
定义知识库文档的质量评分体系、评级标准、检查清单与持续改进机制,确保所有内容达到专业水准
community-guide
RailWise 知识库内容质量标准
Section titled “RailWise 知识库内容质量标准”文档说明:本文档定义 RailWise 知识库所有内容的统一质量标准、评分体系与评级标准。适用于投稿作者、审核员、编辑及质量管理人员。 适用范围:所有知识库文档的撰写、审核、评估与改进
1. 质量维度体系
Section titled “1. 质量维度体系”1.1 六大质量维度
Section titled “1.1 六大质量维度”| 维度 | 权重 | 说明 | 关键指标 |
|---|---|---|---|
| 准确性 | 25% | 技术内容正确、数据可靠 | 错误率、可验证性 |
| 完整性 | 20% | 内容全面、结构完整 | 覆盖率、缺失项 |
| 可读性 | 20% | 语言清晰、易于理解 | 可读性评分、反馈 |
| 实用性 | 15% | 解决实际问题、可操作 | 采用率、收藏率 |
| 规范性 | 10% | 格式规范、符合标准 | 格式检查通过率 |
| 时效性 | 10% | 内容及时、版本匹配 | 更新频率、过期标记 |
1.2 质量评分计算
Section titled “1.2 质量评分计算”总分 = 准确性 × 25% + 完整性 × 20% + 可读性 × 20% + 实用性 × 15% + 规范性 × 10% + 时效性 × 10%
评级:- 90-100 分:⭐⭐⭐⭐⭐ 卓越 (Excellent)- 80-89 分:⭐⭐⭐⭐ 优秀 (Good)- 70-79 分:⭐⭐⭐ 合格 (Acceptable)- 60-69 分:⭐⭐ 待改进 (Needs Improvement)- < 60 分:⭐ 不合格 (Rejected)2. 各维度详细标准
Section titled “2. 各维度详细标准”2.1 准确性(25%)
Section titled “2.1 准确性(25%)”2.1.1 评分标准
Section titled “2.1.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 零错误,可完全信赖 | 专家级准确性,可作为权威参考 |
| 85-94 | 偶有小瑕疵,不影响使用 | 1-2 处非关键错误 |
| 75-84 | 有少量错误,需读者甄别 | 3-5 处错误,或 1 处关键错误 |
| 65-74 | 错误较多,影响使用 | 5+ 处错误,或 2+ 处关键错误 |
| < 65 | 错误严重,不可使用 | 关键概念错误、数据错误 |
2.1.2 检查清单
Section titled “2.1.2 检查清单”## 准确性检查清单
### 技术概念- [ ] 专业术语定义准确- [ ] 技术原理描述正确- [ ] 公式推导无误- [ ] 单位换算正确
### 数据与参数- [ ] 数据标注为"典型值"或"示例数据"- [ ] 数据范围符合行业常识- [ ] 引用的标准编号正确且现行有效- [ ] 标准条款引用准确
### 产品信息- [ ] 产品功能描述与当前版本一致- [ ] API 参数、返回值描述准确- [ ] 操作步骤与产品界面一致- [ ] 版本要求正确
### 案例信息- [ ] 案例描述符合工程实际- [ ] 无虚构不可验证的数据- [ ] 经验总结有依据2.1.3 常见错误示例
Section titled “2.1.3 常见错误示例”| 错误类型 | 错误示例 | 正确写法 |
|---|---|---|
| 概念混淆 | “全站仪精度就是测角精度” | “全站仪精度包括测角精度、测距精度、补偿器精度等” |
| 标准错误 | “GB 50497-2018” | “GB 50497-2019” |
| 数据虚构 | “累计沉降 12.35mm” | “累计沉降典型值约 10-20mm(示例数据)” |
| 版本过时 | “WorkWise v1.5 支持…” | “以当前公开 Release 为准,并链接版本日志” |
| 公式错误 | “Peck公式:S = k·z” | “Peck公式:S(x) = S_max·exp(-x²/(2i²))” |
2.2 完整性(20%)
Section titled “2.2 完整性(20%)”2.2.1 评分标准
Section titled “2.2.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 内容全面,无遗漏 | 覆盖所有相关子主题 |
| 85-94 | 基本完整,少量可补充 | 核心内容齐全,边缘内容可补充 |
| 75-84 | 主要内容完整,有缺失 | 缺少部分重要内容 |
| 65-74 | 内容不完整 | 缺少多个重要部分 |
| < 65 | 严重不完整 | 核心内容缺失 |
2.2.2 按文档类型的完整性要求
Section titled “2.2.2 按文档类型的完整性要求”技术教程类:
必须包含:- [ ] 前置要求(环境、知识、工具)- [ ] 步骤详解(每步有说明)- [ ] 代码/配置示例(如适用)- [ ] 验证方法(如何确认成功)- [ ] 常见问题(至少 3 个)- [ ] 相关资源(链接、参考)项目案例类:
必须包含:- [ ] 项目背景(类型、规模、环境)- [ ] 工程概况(地质、结构、关键参数)- [ ] 监测方案(布点、仪器、频率)- [ ] 典型数据(标注为典型值/示例数据)- [ ] 预警与处置(阈值、响应、措施)- [ ] 经验总结(教训、建议、可复用点)标准解读类:
必须包含:- [ ] 标准基本信息(编号、名称、适用范围)- [ ] 核心条款解读(逐条或分类)- [ ] 实践应用指导(如何落地)- [ ] 与其他标准的关系(对比、引用)- [ ] 常见误区(易错点)- [ ] 更新动态(最新修订)2.3 可读性(20%)
Section titled “2.3 可读性(20%)”2.3.1 评分标准
Section titled “2.3.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 行文流畅,引人入胜 | 专业且易读,适合目标读者 |
| 85-94 | 清晰易懂,偶有冗长 | 整体良好,个别段落可优化 |
| 75-84 | 基本可读,有改进空间 | 句子过长、术语过多 |
| 65-74 | 阅读吃力 | 结构混乱、语言晦涩 |
| < 65 | 难以理解 | 严重影响信息获取 |
2.3.2 可读性指标
Section titled “2.3.2 可读性指标”| 指标 | 目标值 | 测量工具 |
|---|---|---|
| 平均句长 | < 25 字 | 文本分析工具 |
| 段落长度 | < 150 字 | 文本分析工具 |
| 术语密度 | < 15% | 术语识别工具 |
| Flesch 阅读 ease | > 50(中文等效) | 可读性分析 |
| 标题层级 | 3-4 层 | 结构检查 |
2.3.3 可读性优化建议
Section titled “2.3.3 可读性优化建议”2.4 实用性(15%)
Section titled “2.4 实用性(15%)”2.4.1 评分标准
Section titled “2.4.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 立即可用,解决实际问题 | 读者可直接按文档操作 |
| 85-94 | 高度实用,少量需适配 | 需要根据实际情况微调 |
| 75-84 | 有实用价值,但不够具体 | 缺少具体参数或步骤 |
| 65-74 | 理论为主,实用较弱 | 偏概念,缺少操作指导 |
| < 65 | 脱离实际 | 内容无法指导实践 |
2.4.2 实用性检查清单
Section titled “2.4.2 实用性检查清单”- [ ] 读者能按文档完成操作(教程类)- [ ] 案例经验可复用(案例类)- [ ] 参数范围有参考价值(技术类)- [ ] 提供了可下载的模板/脚本(工具类)- [ ] 标注了适用条件与限制- [ ] 给出了常见问题的解决方案2.5 规范性(10%)
Section titled “2.5 规范性(10%)”2.5.1 评分标准
Section titled “2.5.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 完全符合规范 | 格式、结构、标签均规范 |
| 85-94 | 基本规范,少量问题 | 1-2 处格式问题 |
| 75-84 | 有规范问题 | 3-5 处格式问题 |
| 65-74 | 规范问题较多 | 影响阅读体验 |
| < 65 | 严重不规范 | 需要重写格式 |
2.5.2 规范检查清单
Section titled “2.5.2 规范检查清单”## 格式规范检查
### Frontmatter- [ ] 所有必填字段齐全- [ ] title 简洁明确(< 50 字)- [ ] description 准确概括(< 100 字)- [ ] category 符合分类体系- [ ] tags 数量 3-8 个- [ ] date 格式正确(YYYY-MM-DD)
### 正文结构- [ ] 有且仅有一个 H1 标题- [ ] 标题层级连续(无跳级)- [ ] 标题使用 sentence case- [ ] 表格有表头- [ ] 代码块有语言标识- [ ] 图片有 alt 文本
### 提示框使用- [ ] :::tip 用于补充技巧- [ ] :::warning 用于重要警告- [ ] :::info 用于补充信息- [ ] :::danger 用于危险操作(谨慎使用)
### 交叉引用- [ ] 相关文档链接使用相对路径- [ ] 链接指向的文档存在- [ ] 外部链接标注来源
### 元数据标签- [ ] AI 语义标签完整- [ ] meta 标签包含 ai-tags, ai-intent, ai-audience2.6 时效性(10%)
Section titled “2.6 时效性(10%)”2.6.1 评分标准
Section titled “2.6.1 评分标准”| 分数 | 标准 | 说明 |
|---|---|---|
| 95-100 | 最新内容,版本匹配 | 与当前产品版本一致 |
| 85-94 | 基本时效,轻微滞后 | 内容仍可用,有小更新 |
| 75-84 | 有滞后,需更新 | 部分内容与现状不符 |
| 65-74 | 明显过时 | 多处内容与现状不符 |
| < 65 | 严重过时 | 内容已不可用 |
2.6.2 时效性管理
Section titled “2.6.2 时效性管理”| 文档类型 | 建议更新周期 | 过期标记 |
|---|---|---|
| 产品文档 | 随产品版本更新 | 版本不匹配时标记 |
| 标准解读 | 标准修订时更新 | 标准废止时标记 |
| 技术教程 | 每年审查 | 2 年未更新标记 |
| 项目案例 | 无需定期更新 | 技术过时标记 |
| 行业洞察 | 每季度更新 | 6 个月未更新标记 |
3. 质量评级与应用
Section titled “3. 质量评级与应用”3.1 评级与权益
Section titled “3.1 评级与权益”| 评级 | 分数 | 标识 | 应用 |
|---|---|---|---|
| ⭐⭐⭐⭐⭐ 卓越 | 90-100 | 金色徽章 | 首页推荐、精选集、付费内容候选 |
| ⭐⭐⭐⭐ 优秀 | 80-89 | 银色徽章 | 分类推荐、搜索加权 |
| ⭐⭐⭐ 合格 | 70-79 | 标准 | 正常展示 |
| ⭐⭐ 待改进 | 60-69 | 标记 | 提示改进建议,限期优化 |
| ⭐ 不合格 | < 60 | 隐藏 | 退回修改,不展示 |
3.2 质量改进流程
Section titled “3.2 质量改进流程”评级发布 ↓[待改进] → 发送改进建议 → 作者修改 → 重新评分 ↓[合格+] → 持续监控 → 定期复审 → 升级/降级 ↓[卓越] → 精选推荐 → 定期维护 → 保持质量4. 质量工具
Section titled “4. 质量工具”4.1 自动化质量检查
Section titled “4.1 自动化质量检查”# 运行质量检查npm run quality-check -- article.md
# 输出示例质量检查报告:article.md━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━准确性: 88/100 ✅ 优秀完整性: 82/100 ✅ 优秀可读性: 75/100 ⚠️ 合格(平均句长 32 字,建议缩短)实用性: 90/100 ✅ 卓越规范性: 95/100 ✅ 卓越时效性: 85/100 ✅ 优秀━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━总分: 85.8/100 ⭐⭐⭐⭐ 优秀
建议改进:1. 可读性:第 3 节平均句长 45 字,建议拆分为短句2. 完整性:缺少"常见问题"部分4.2 人工审核评分表
Section titled “4.2 人工审核评分表”| 维度 | 分数 | 评语 | 审核员 |
|---|---|---|---|
| 准确性 | |||
| 完整性 | |||
| 可读性 | |||
| 实用性 | |||
| 规范性 | |||
| 时效性 | |||
| 总分 | 评级 |
5. 相关文档
Section titled “5. 相关文档”文档版本:v1.0.0 | 发布日期:2026-07-08 | 下次更新:2026-08-08
