RailWise KB已发布
TSM 版本发布说明规范
RAILWISE-TSM全站仪自动化监测平台版本发布说明的标准模板、技术规范与发布流程
community-guide
TSM 版本发布说明规范
Section titled “TSM 版本发布说明规范”文档说明：RAILWISE-TSM 是面向监测单位的核心业务平台，版本发布涉及服务端、客户端、固件、配置等多维度变更。本文档规范 TSM 版本发布说明的撰写标准与发布流程。 适用范围：TSM 产品团队、运维团队、监测项目技术负责人
1. TSM 版本体系
Section titled “1. TSM 版本体系”1.1 版本组件
Section titled “1.1 版本组件”TSM 采用多组件版本体系，一个版本发布可能涉及多个组件：
| 组件 | 版本号示例 | 说明 | 独立升级 |
|---|---|---|---|
| 服务端 | tsm-server@3.2.1 |
NestJS 后端服务 | ✅ 支持热更新 |
| Web 客户端 | tsm-web@3.2.1 |
Next.js 前端应用 | ✅ 支持独立升级 |
| 采集服务 | tsm-acquisition@3.2.1 |
全站仪数据采集服务 | ⚠️ 需重启 |
| 计算引擎 | tsm-compute@3.2.1 |
Rust/WASM 计算核心 | ⚠️ 需重启 |
| 移动端 | tsm-mobile@3.2.1 |
UniApp 外业 App | ✅ 独立升级 |
| 固件 | tsm-firmware@2.1.0 |
边缘采集设备固件 | ❌ 需现场操作 |
1.2 版本发布类型
Section titled “1.2 版本发布类型”| 类型 | 触发条件 | 发布频率 | 影响范围 |
|---|---|---|---|
| 常规版本 | 功能迭代完成 | 每 2-4 周 | 服务端 + Web 端 |
| 热修复 | 线上严重 Bug | 按需，24h 内 | 单组件 |
| 安全补丁 | 安全漏洞修复 | 按需，48h 内 | 全组件 |
| 固件更新 | 设备兼容性/功能 | 每季度 | 现场设备 |
| 数据库迁移 | schema 变更 | 随常规版本 | 全局 |
2. 发布说明模板
Section titled “2. 发布说明模板”2.1 标准模板
Section titled “2.1 标准模板”---title: "TSM v{版本号} 版本发布说明"description: "TSM {版本号} 版本的服务端、客户端、固件更新内容与升级指南"category_primary: "产品文档"category_secondary: "版本更新"tags: ["tsm", "版本发布", "v{版本号}", "全站仪自动化监测"]author: "RailWise TSM团队"date: "{发布日期}"version: "{版本号}"---
# TSM v{版本号} 版本发布说明
> **发布日期**：{YYYY-MM-DD}> **版本类型**：{常规版本/热修复/安全补丁/固件更新}> **计划维护窗口**：{YYYY-MM-DD HH:MM} ~ {HH:MM}（预计 {时长} 分钟）> **影响范围**：{全局/特定模块/特定客户}
---
## 版本概览
| 组件 | 版本 | 变更类型 | 升级方式 | 预计停机 ||------|------|----------|----------|----------|| tsm-server | v{x.x.x} | {新增/修复/优化} | 热更新 | 0 分钟 || tsm-web | v{x.x.x} | {新增/修复/优化} | 独立部署 | 0 分钟 || tsm-acquisition | v{x.x.x} | {新增/修复/优化} | 滚动重启 | 2 分钟 || tsm-compute | v{x.x.x} | {新增/修复/优化} | 滚动重启 | 1 分钟 || tsm-mobile | v{x.x.x} | {新增/修复/优化} | 应用商店 | 0 分钟 || tsm-firmware | v{x.x.x} | {新增/修复/优化} | 现场刷写 | 需预约 |
---
## 服务端更新
### 新增功能
| 功能 | 模块 | 说明 | 配置变更 ||------|------|------|----------|| 功能名称 | 所属模块 | 功能描述 | 是否需要配置调整 |
### API 变更
| 端点 | 变更类型 | 说明 | 兼容性 ||------|----------|------|--------|| `GET /api/...` | {新增/修改/废弃} | 变更说明 | {兼容/不兼容} |
### 数据库变更
| 变更类型 | 对象 | 说明 | 迁移脚本 ||----------|------|------|----------|| {新增表/修改字段/索引} | 表名/字段名 | 变更说明 | `migration_{版本}.sql` |
---
## Web 客户端更新
### 界面变更
| 页面/组件 | 变更类型 | 说明 | 截图 ||-----------|----------|------|------|| 页面名称 | {新增/重构/优化} | 变更描述 | [查看截图] |
### 交互优化
- 优化项描述
---
## 采集服务更新
### 设备兼容性
| 设备型号 | 固件要求 | 支持状态 ||----------|----------|----------|| 徕卡 TM60 | ≥ 3.0 | ✅ 完全支持 || 拓普康 MS1A | ≥ 2.1 | ✅ 完全支持 |
### 采集策略变更
| 策略 | 旧行为 | 新行为 | 影响 ||------|--------|--------|------|| 策略名称 | 原行为 | 新行为 | 对现有项目的影响 |
---
## 计算引擎更新
### 算法变更
| 算法 | 版本 | 变更说明 | 精度影响 ||------|------|----------|----------|| 算法名称 | v{x.x} | 变更描述 | 对结果精度的影响 |
### 性能优化
| 场景 | 优化前 | 优化后 | 提升幅度 ||------|--------|--------|----------|| 场景描述 | 基准数据 | 优化后数据 | 百分比 |
---
## 移动端更新
### 新功能
- 功能描述
### 兼容性
| 平台 | 最低版本 | 推荐版本 ||------|----------|----------|| iOS | {版本} | {版本} || Android | {版本} | {版本} |
---
## 固件更新（如适用）
### 固件版本
| 设备类型 | 旧版本 | 新版本 | 更新方式 | 预计耗时 ||----------|--------|--------|----------|----------|| 边缘采集器 | v{x.x.x} | v{x.x.x} | OTA/现场 | {时长} |
### 固件更新注意事项
> ⚠️ 固件更新期间设备将暂停采集，请避开监测高峰期操作
---
## 升级指南
### 自动升级（SaaS 客户）
维护窗口期间自动完成，无需操作。
### 私有化部署升级
```bash# 1. 备份数据tsm-cli backup --output /backup/tsm-v{旧版本}-{日期}.tar.gz
# 2. 下载新版本tsm-cli pull --version v{新版本}
# 3. 执行升级tsm-cli upgrade --version v{新版本} --migration auto
# 4. 验证升级tsm-cli health-check升级后验证清单
Section titled “升级后验证清单”- 系统健康检查通过
- 核心 API 响应正常
- 数据采集测试通过
- 报告生成测试通过
- 告警通知测试通过
- 用户登录与权限验证
| 场景 | 回滚方式 | 预计耗时 | 数据影响 |
|---|---|---|---|
| 升级失败 | tsm-cli rollback --to v{旧版本} |
5 分钟 | 无数据丢失 |
| 数据库迁移失败 | 自动回滚 + 人工介入 | 10 分钟 | 需检查一致性 |
| 问题 | 影响 | 临时方案 | 预计修复 |
|---|---|---|---|
| 问题描述 | 影响范围 | 临时解决方案 | 目标版本 |
文档版本：v{版本号} | 发布日期：{YYYY-MM-DD}
---
## 3. 发布前检查清单
### 3.1 技术检查项
```markdown- [ ] 所有组件版本号已确认并统一- [ ] 数据库迁移脚本已测试（正向 + 回滚）- [ ] API 变更已记录兼容性影响- [ ] 固件更新包已签名验证- [ ] 自动化测试通过率 100%- [ ] 性能基准测试通过- [ ] 安全扫描无高危漏洞- [ ] 配置变更文档已更新3.2 运营检查项
Section titled “3.2 运营检查项”- [ ] 维护窗口已通知所有客户- [ ] 发布说明已技术文档团队审核- [ ] 客户成功团队已培训新功能- [ ] 常见问题 FAQ 已准备- [ ] 升级支持人员已排班- [ ] 回滚方案已验证可用4. 客户通知模板
Section titled “4. 客户通知模板”4.1 维护窗口通知（提前 48h）
Section titled “4.1 维护窗口通知（提前 48h）”主题：[维护通知] TSM 平台 v{版本号} 升级维护
尊敬的 TSM 用户：
我们将于 {日期} {时间} 进行 TSM 平台升级维护，预计耗时 {时长} 分钟。
维护期间影响：- Web 端：可能短暂无法访问（预计 2 分钟）- 数据采集：自动监测项目暂停（维护窗口内）- 报告生成：暂停服务
升级亮点：1. {功能1}2. {功能2}3. {功能3}
如有疑问，请联系技术支持：support@railwise.cn
RailWise TSM 团队4.2 升级完成通知
Section titled “4.2 升级完成通知”主题：[已完成] TSM 平台 v{版本号} 升级成功
TSM 平台已成功升级至 v{版本号}。
新功能体验：- {功能1}：[操作指南链接]- {功能2}：[操作指南链接]
如遇问题，请通过以下方式反馈：- 工单系统：[链接]- 技术支持：support@railwise.cn5. 版本支持策略
Section titled “5. 版本支持策略”| 版本系列 | 状态 | 支持截止 | 补丁策略 |
|---|---|---|---|
| v3.x | ✅ 活跃维护 | v4.0 发布后 12 个月 | 全量支持 |
| v2.x | ⚠️ 维护模式 | 2026-12-31 | 仅安全补丁 |
| v1.x | ❌ 已停止 | 2025-06-30 | 无支持 |
- SaaS 客户：自动跟随最新版本
- 私有化客户：建议每季度升级一次，至少保持 N-1 版本
- 固件版本：建议与 TSM 服务端版本配套升级
6. 相关文档
Section titled “6. 相关文档”- CLI 更新日志模板 — CLI 产品更新规范
- WorkWise 更新说明 — 桌面端产品更新规范
- OS 版本公告 — 业务系统版本发布规范
- 通用更新流程指南 — 跨产品统一发布流程
文档版本：v1.0.0 | 发布日期：2026-07-08 | 下次更新：2026-08-08