如何投稿：社区贡献指南

如何投稿：社区贡献指南

欢迎贡献

感谢您对RailWise知识库的关注！我们欢迎所有形式的贡献，包括但不限于：

• 📄 文档撰写：技术文档、使用教程、案例分享
• 🔧 工具开发：开源工具、脚本、插件
• 🐛 问题反馈：Bug报告、功能建议
• 💡 经验分享：项目经验、最佳实践
• 🌐 翻译贡献：多语言文档翻译

投稿方式

方式一：GitHub Pull Request（推荐）

适合有GitHub使用经验的贡献者。

步骤：

1. Fork仓库

   # 访问 https://github.com/railwise/knowledge-base
   # 点击 Fork 按钮

2. 克隆仓库

   git clone https://github.com/您的用户名/knowledge-base.git
   cd knowledge-base

3. 创建分支

   git checkout -b contrib/{文档类型}-{简短描述}
   # 示例: git checkout -b contrib/scenario-deep-excavation

4. 编写文档

   • 遵循内容质量标准
   • 使用Markdown格式
   • 包含完整的YAML Frontmatter

5. 提交更改

   git add .
   git commit -m "docs: 添加{文档标题}"
   git push origin contrib/{分支名}

6. 创建Pull Request

   • 访问您的Fork仓库
   • 点击 “New Pull Request”
   • 填写PR描述模板

方式二：在线编辑器

适合不熟悉Git的贡献者。

步骤：

1. 访问 RailWise知识库编辑平台
2. 使用GitHub账号登录
3. 点击 “新建文档”
4. 在线编辑文档内容
5. 提交审核

方式三：邮件投稿

适合不方便使用GitHub的贡献者。

步骤：

1. 下载文档模板
2. 按模板编写文档
3. 发送至: contribute@railwise.cn
4. 邮件标题格式: [投稿] {文档标题} - {作者姓名}

内容要求

文档类型

类型	说明	示例
技术文档	产品使用指南、API文档	CLI命令参考
教程	操作步骤详解	TSM部署教程
案例	项目经验分享	深基坑监测案例
标准解读	国家标准AI解读	GB 50497解读
工具	开源工具使用说明	数据处理脚本
翻译	多语言文档	英文版文档

内容规范

所有投稿文档必须包含：

1. YAML Frontmatter

   ---
   title: "文档标题"
   description: "文档描述"
   category_primary: "主分类"
   category_secondary: "次分类"
   tags: ["标签1", "标签2"]
   author: "作者姓名"
   date: "YYYY-MM-DD"
   version: "1.0"
   ---

2. 结构化正文

   • 使用Markdown格式
   • 标题层级清晰（H1-H4）
   • 适当使用表格、代码块、提示框

3. 相关文档链接

   • 引用其他文档时使用相对路径
   • 格式: [文档名](../路径/文档名.md)

4. AI语义标签

   • 文档末尾添加AI语义标签注释
   • 格式: <!-- AI语义标签: 标签1, 标签2 -->

投稿 checklist

提交前请确认：

• 文档内容原创或已获得授权
• 包含完整的YAML Frontmatter
• 使用Markdown格式
• 包含AI语义标签
• 已检查拼写和语法
• 已验证相关文档链接正确
• 已添加适当的截图或图表（如需要）
• 不包含敏感信息或商业机密

审核流程

投稿提交后，将进入文档审核流程：

投稿提交 → 自动检查 → 初审 → 技术审核 → 质量审核 → 发布

审核周期通常为3-7个工作日。

奖励机制

投稿被采纳后，您将获得：

• 🏆 积分奖励：根据文档质量获得50-500积分
• 🎖️ 贡献者徽章：个人资料页展示贡献者徽章
• 📢 署名展示：文档页显示作者信息
• 🎁 实物奖励：年度优秀贡献者获得RailWise周边礼品

详细奖励规则请参见积分与激励体系。

常见问题

Q1: 我可以投稿翻译文档吗？

可以。我们欢迎将中文文档翻译为其他语言，或将外文资料翻译为中文。翻译文档需注明原文出处和译者信息。

Q2: 投稿被拒绝后还能修改再投吗？

可以。审核反馈会说明拒绝原因，您可以根据反馈修改后重新提交。多次修改有助于提升文档质量。

Q3: 我可以投稿尚未公开的项目案例吗？

可以，但需脱敏处理。请确保：

• 删除或替换敏感信息（项目名称、地点、单位名称等）
• 数据使用“典型值”或“示例数据”标注
• 获得项目相关方授权（如需要）

Q4: 投稿有版权要求吗？

投稿默认采用 CC BY-SA 4.0 协议授权。如您有特殊版权要求，请在投稿时说明。

联系方式

• 投稿咨询: contribute@railwise.cn
• 技术支持: support@railwise.cn
• 社区讨论: GitHub Discussions

---

相关文档

• 文档审核流程
• 内容质量标准
• 积分与激励体系
• 优秀贡献者案例