RailWise KB已发布

RailWise 知识库投稿指南

面向社区贡献者的完整投稿指南，涵盖投稿渠道、内容规范、格式要求、审核流程与奖励机制，帮助贡献者高效参与知识库建设

复核 2026-07-09入门公开可引用RailWise 技术团队

community-guide

RailWise 知识库投稿指南

欢迎加入 RailWise 知识库共建！

无论你是资深监测工程师、技术开发者、学术研究者，还是刚入行的新人，你的经验和见解都能帮助更多人。本指南将带你了解如何向 RailWise 知识库投稿，从选题到发布的完整流程。

1. 投稿前准备

1.1 了解知识库定位

RailWise 知识库聚焦以下领域：

领域	内容方向	示例
工程监测技术	监测方案设计、仪器操作、数据处理	全站仪自动化监测实施经验
产品使用教程	CLI/WorkWise/TSM/OS 操作指南	WorkWise 工作流配置详解
标准规范解读	GB/JGJ/CJJ 等标准实践应用	GB 50497 在地铁保护区的应用
项目案例分享	真实项目经验（去敏感化）	深基坑监测项目复盘
行业洞察分析	技术趋势、标准动态、学术转化	自动化监测技术发展趋势
开发技术分享	API 集成、二次开发、工具脚本	TSM API 自动化数据采集脚本

1.2 投稿资格

身份	可投稿内容	审核流程
注册用户	评论、纠错、补充建议	自动发布
认证工程师	技术文章、案例分享	快速审核（24h）
认证开发者	开发教程、API 指南、工具分享	快速审核（24h）
合作伙伴	产品集成方案、联合解决方案	标准审核（48h）
内部团队	官方文档、产品更新	内部审核

工程师认证：上传职业资格证书或项目经历证明
开发者认证：GitHub 账号关联 + 技术能力测试
合作伙伴认证：企业资质审核 + 合作协议签署

2. 投稿渠道

2.1 渠道对比

渠道	适用场景	响应速度	适合内容
GitHub PR	技术文档、代码示例	2-3 天	开发类、格式规范的内容
在线编辑器	快速发布、非技术内容	即时保存	经验分享、案例复盘
邮件投稿	大文件、附件较多	3-5 天	含大量图片/附件的文档
社区论坛	讨论性内容、初稿征集	即时	想法验证、草稿征集反馈

2.2 GitHub PR 投稿流程（推荐）

# Step 1: Fork 知识库仓库
git clone https://github.com/railwise/kb-content.git
cd kb-content

# Step 2: 创建分支
git checkout -b article/my-article-title

# Step 3: 编写文档（遵循格式规范）
# 详见第 3 节格式要求

# Step 4: 本地预览
npm run preview

# Step 5: 提交 PR
git add .
git commit -m "docs: 添加[文章标题]"
git push origin article/my-article-title
# 然后在 GitHub 上创建 Pull Request

2.3 在线编辑器投稿流程

打开 RailWise 知识库投稿表单
填写投稿人、标题、分类、摘要与 Markdown 正文
点击 “提交审核”，内容会进入主站后台的“知识库管理 / 社区投稿”
审核通过后由编辑转为知识库草稿，再进入复核与发布流程
等待审核结果（邮件或人工通知）

2.4 邮件投稿

将稿件发送至：docs@railwise.cn

邮件格式：

主题：[投稿] 文章标题 - 作者姓名

正文：
- 文章标题：
- 作者姓名：
- 作者身份：工程师/开发者/学生/其他
- 文章分类：技术/案例/教程/其他
- 文章摘要：200字以内
- 是否首发：是/否（如已在其他平台发布，请附链接）

附件：
- 文章 Markdown 文件
- 图片素材（如有）
- 作者头像（可选）

3. 文档格式规范

3.1 必须包含的 Frontmatter

每篇投稿文档必须在开头包含 YAML Frontmatter：

---
title: "文章标题（简洁明确）"
description: "文章描述（100字以内，用于搜索和摘要）"
category_primary: "一级分类"
category_secondary: "二级分类"
tags: ["标签1", "标签2", "标签3"]
author: "作者姓名或昵称"
date: "YYYY-MM-DD"
version: "1.0.0"
applicable_scenarios: ["适用场景1", "适用场景2"]
standard_refs: ["相关标准编号"]
---

3.2 分类体系

一级分类	二级分类	说明
场景解决方案	深基坑/盾构/保护区/桥梁/边坡/管廊	工程监测场景方案
项目案例	深基坑/盾构/保护区/桥梁/边坡/管廊/综合	实际项目经验
产品文档	CLI/WorkWise/TSM/OS/通用	产品使用指南
技术规范	国家标准/行业标准/企业标准	标准规范解读
工程工具	计算工具/代码模板/数据处理	实用工具分享
API/SDK/MCP	API/ SDK/ MCP/ Webhook	开发者文档
AI工具	AI助手/代码生成/方案生成	AI 应用分享
行业洞察	技术前沿/标准动态/学术转化	行业分析
社区资源	学习路径/开源工具/会议/数据集	社区资源

3.3 正文结构规范

# 文章标题

> **摘要**：一句话概括文章核心内容
> **关键词**：关键词1, 关键词2, 关键词3
> **阅读时间**：约 X 分钟
> **难度**：初级/中级/高级

---

## 1. 引言/背景

说明文章要解决什么问题，适用场景。

## 2. 主体内容（多级标题）

### 2.1 子标题

正文内容...

:::tip 提示框
使用 :::tip 提供实用技巧
:::

:::warning 警告框
使用 :::warning 提醒注意事项
:::

:::info 信息框
使用 :::info 补充说明信息
:::

## 3. 代码示例（如适用）

```python
# 代码必须有注释
print("Hello, RailWise!")

4. 表格（数据对比）

列1	列2	列3
数据	数据	数据

5. 总结

核心要点回顾…

6. 相关文档

元数据标签

本文最后更新于 YYYY-MM-DD | 作者：姓名 | 版本：v1.0.0

### 3.4 图片规范

| 要求 | 规范 |
|------|------|
| 格式 | PNG（推荐）或 JPG |
| 宽度 | 最大 1200px |
| 文件大小 | 单张不超过 500KB |
| 命名 | `文章缩写-序号-描述.png` |
| 标注 | 关键数据需用"典型值"或"示例数据"标注 |
| 版权 | 使用原创截图或注明来源 |

---

## 4. 内容质量标准

### 4.1 必须遵守

| 要求 | 说明 | 检查方式 |
|------|------|----------|
| **原创性** | 不得抄袭，引用需注明出处 | 查重检测 |
| **准确性** | 技术内容准确，数据可验证 | 技术审核 |
| **实用性** | 解决实际问题，可操作 | 场景审核 |
| **安全性** | 不泄露敏感项目数据 | 敏感信息审核 |
| **可读性** | 结构清晰，语言通顺 | 编辑审核 |

### 4.2 禁止内容

- ❌ 虚构不可验证的项目数据（如具体工程数值）
- ❌ 泄露客户信息、项目坐标、设计参数等敏感信息
- ❌ 攻击竞品或个人的内容
- ❌ 与工程监测无关的广告推广
- ❌ 侵犯版权的图片、代码、文档
- ❌ AI 生成内容未标注（允许使用 AI 辅助，但需人工审核并标注）

### 4.3 数据标注规范

:::warning 数据使用规范
所有工程数据必须使用以下方式标注：
- **典型值**："地表沉降典型值约 5-15mm"（基于行业经验范围）
- **示例数据**："示例数据：累计沉降 12.3mm（仅为演示，非真实项目数据）"
- **引用标准**："根据 GB 50497-2019，报警值通常为控制值的 80%"
- **真实数据**：如需使用真实数据，必须获得数据所有方书面授权
:::

---

## 5. 审核流程

### 5.1 审核阶段

投稿提交 ↓ [自动检查] — 格式、敏感词、重复检测（即时） ↓ [技术审核] — 内容准确性（1-2 天） ↓ [编辑审核] — 语言、结构、可读性（1 天） ↓ [终审发布] — 最终确认（半天） ↓ 发布上线 + 通知作者

### 5.2 审核结果

| 结果 | 说明 | 后续操作 |
|------|------|----------|
| **直接通过** | 质量优秀，无需修改 | 立即发布，发放积分 |
| **小修改后通过** | 少量问题，作者修改后通过 | 返回修改建议 |
| **大修改后重审** | 结构或内容需调整 | 返回详细修改意见 |
| **暂不采纳** | 不符合知识库定位或质量要求 | 说明原因，鼓励改进 |

### 5.3 审核时间承诺

| 投稿类型 | 承诺审核时间 | 加急通道 |
|----------|-------------|----------|
| 常规投稿 | 5 个工作日 | 认证用户 3 天 |
| 纠错/补充 | 2 个工作日 | 自动通过（低敏感） |
| 紧急技术文档 | 1 个工作日 | 联系社区运营 |

---

## 6. 奖励与激励

### 6.1 积分体系

| 行为 | 积分 | 说明 |
|------|------|------|
| 首次投稿并通过 | 100 分 | 欢迎奖励 |
| 每篇技术文章 | 50-200 分 | 根据质量评级 |
| 每篇案例分享 | 100-300 分 | 根据案例价值 |
| 文档纠错被采纳 | 10-50 分 | 根据纠错价值 |
| 回答社区问题 | 5-30 分 | 被采纳的回答 |
| 翻译文档 | 80-150 分 | 根据翻译质量 |
| 视频教程 | 200-500 分 | 根据时长和质量 |

### 6.2 等级权益

| 等级 | 积分要求 | 权益 |
|------|----------|------|
| **见习 contributor** | 0 分 | 基础投稿权限 |
| **初级 contributor** | 100 分 | 快速审核通道 |
| **中级 contributor** | 500 分 | 文章推荐位、专属标识 |
| **高级 contributor** | 2000 分 | 审核绿色通道、线下活动邀请 |
| **专家 contributor** | 5000 分 | 专栏开设、付费内容分成、年度大会演讲 |
| **核心 contributor** | 10000 分 | 知识库治理参与、产品内测资格 |

### 6.3 实物奖励

| 奖励 | 获取条件 | 价值 |
|------|----------|------|
| RailWise 周边 | 季度积分 Top 10 | 定制礼品 |
| 技术书籍 | 年度优秀贡献者 | 200-500 元 |
| 会议门票 | 年度大会演讲嘉宾 | 2000-5000 元 |
| 产品授权 | 核心 contributor | WorkWise/TSM 授权 |
| 现金奖励 | 年度 Top 3 贡献者 | 1000-5000 元 |

---

## 7. 常见问题

### Q1: 我可以投稿已经在其他平台发布过的文章吗？

可以，但需要：
- 在 Frontmatter 中注明 `original_platform: "平台名称"`
- 确保你有权在其他平台发布
- 建议根据 RailWise 知识库格式做适当调整

### Q2: 投稿后版权归谁？

- 作者保留文章版权
- 授予 RailWise 知识库永久展示权
- 允许 RailWise 在宣传、翻译、改编中使用（会注明作者）

### Q3: 我可以使用 AI 辅助写作吗？

可以，但需要：
- 在 Frontmatter 中标注 `ai_assisted: true`
- 人工审核技术准确性
- 确保内容符合质量标准

### Q4: 投稿被拒绝了怎么办？

- 仔细阅读审核反馈，针对性修改
- 在论坛发帖讨论，获取社区建议
- 联系社区运营（community@railwise.cn）获取指导

### Q5: 如何追踪投稿状态？

- GitHub PR：PR 页面实时查看
- 在线编辑器：个人中心 → 我的投稿
- 邮件投稿：回复邮件询问进度

---

## 8. 投稿资源

### 8.1 写作工具

| 工具 | 用途 | 链接 |
|------|------|------|
| Markdown 编辑器 | 在线编辑 | [RailWise 编辑器](https://kb.railwise.cn/editor) |
| 格式检查工具 | 自动检查 Frontmatter | [格式检查](https://kb.railwise.cn/lint) |
| 图片压缩 | 压缩图片至 500KB 以下 | [TinyPNG](https://tinypng.com) |
| 语法检查 | 中文语法和错别字 | [写作猫](https://xiezuocat.com) |

### 8.2 参考文档

- [内容质量标准](content-quality-standards.md) — 详细质量评分标准
- [文档审核流程](document-review-process.md) — 审核流程详解
- [积分与激励体系](contribution-rewards-system.md) — 积分规则与权益
- [优秀贡献者案例](outstanding-contributors.md) — 学习优秀投稿

---

## 9. 联系社区运营

| 渠道 | 用途 | 联系方式 |
|------|------|----------|
| 投稿咨询 | 投稿相关问题 | docs@railwise.cn |
| 审核进度 | 查询审核状态 | community@railwise.cn |
| 内容建议 | 知识库内容规划建议 | feedback@railwise.cn |
| 紧急联系 | 紧急技术文档投稿 | 微信：RailWise_Community |

---

## 元数据标签

<!-- AI-SEMANTIC-TAGS: 投稿指南, 社区贡献, 知识库共建, 文档写作, 开源协作, 内容创作 -->
<meta name="ai-tags" content="contribution-guide, community, knowledge-base, documentation, open-source, content-creation" />
<meta name="ai-intent" content="指导用户如何向知识库投稿, 降低贡献门槛, 规范投稿流程" />
<meta name="ai-audience" content="所有希望参与知识库建设的工程师, 开发者, 技术写作者" />

---

*文档版本：v1.0.0 | 发布日期：2026-07-08 | 下次更新：2026-08-08*