案例 - SHD Manage System 特性管理系统

SMS 是一款基于 Go + React 技术栈开发的高性能、现代化的特性管理平台。它是为践行 文档驱动开发 (Document-Driven Development, DDD) 理念而生的协作引擎。

在传统的软件开发流程中,需求文档、UI 设计稿、API 接口定义和测试用例往往散落在不同的工具(如 Word, Figma, Swagger, Excel)中,导致信息割裂和版本不一致。SMS 作为团队的 “单一事实来源 (Single Source of Truth)”,将后端、前端、UI 设计师和测试工程师的工作流无缝串联。它不仅管理结构化数据,更通过标准化的数据输出,为 AI 辅助生成自动化测试代码 提供了坚实的基础。

一、核心功能:打破孤岛的全链路协作

为了实现跨职能团队的高效协同,SMS 构建了五大核心功能模块:

🧩 结构化的特性全生命周期管理

SMS 摒弃了传统的非结构化文档,采用原子化的“特性 (Feature)”作为管理单元。每个特性都包含富文本的介绍与说明,支持和引导特性设计人员从架构、流程上对需求进行澄清。此外支持一键导出 PDF,这使得开发人员和 AI 都能清晰理解业务逻辑的上下文。

🎨 带有版本控制的 UI 设计交付

解决了“开发做的界面不是设计稿最新版”的痛点。SMS 允许 UI 设计师上传设计图的版本归档,并支持针对特定版本通过一或多张预览图陈述设计理念。前端开发人员可以随时下载确定的版本资源,确保 1:1 还原设计。

🔌 契约式的 API 规范定义

SMS 内置了轻量级的 API 管理模块。后端与前端在此达成“契约”:明确 HTTP 方法、URL、请求/响应的 JSON 结构、字段描述及限制条件。特别地,系统支持为同一 API 定义多个“样例”,精确描述不同业务场景下的参数变化,为 Mock Server 和 AI 接口测试 提供精准输入。

🖱️ 面向测试的用户操作编排

这是 SMS 区别于传统 Wiki 的核心亮点。系统允许产品或测试人员以结构化的方式(步骤标题 + 详细描述 + 预期结果)记录用户操作路径。这些结构化数据直接对应 End-to-End (E2E) 测试用例 的逻辑,使得 AI 能够读取这些步骤并自动生成 Cypress 或 Selenium 代码。

👥 角色驱动的权限体系

基于 JWT 的安全认证机制,支持精细化的用户管理。系统不仅管理账户状态,还引入了“项目”和“角色”概念(如经理、前端、后端、测试等),通过对项目进行人员分配和项目存档设置,确保正确的人在正确的时间看到正确的信息,同时记录每一次对特性的变更操作,保障数据安全与可追溯性。

二、工作流:从定义到 AI 赋能的闭环

SMS 的核心价值在于建立了一个从需求定义到测试验证的自动化闭环:

产品定义 (Product Definition)::产品经理在 SMS 中创建项目(如“SmartCampus NetManager”),并拆解为多个特性(Feature)。通过关联逻辑,勾勒出业务蓝图。

设计规约 (Design & Contract)::UI 设计师上传设计稿至对应特性下,锁定视觉标准。架构师/后端定义 API 接口规范,确立数据标准。前端根据设计稿和 API,在 SMS 中录入“用户操作”步骤。

AI 驱动的测试生成 (AI-Powered Generation)::这是 SMS 的终极目标。外部 AI 引擎通过 API 读取 SMS 中的 [架构描述 + API 定义 + 用户操作步骤],自动推理出测试逻辑,并生成高质量的自动化测试代码(如 Python Pytest 或 Go Test)。

DDD

三、技术亮点:Go + React 的现代架构

SMS 在技术选型上追求极致的性能、开发体验与部署便捷性,同时集成了自动化的 DevOps CI/CD 流程:

高性能后端 (Go 1.25):

  • 利用 Go 语言的高并发特性与 Gin 框架的轻量级优势,确保 API 的毫秒级响应。
  • SQLite + GORM 的组合实现了“零依赖部署”,无需复杂的数据库运维,单个文件即可承载整个系统数据,极其适合私有化部署。
  • JWT 中间件保障了无状态的分布式会话管理。

现代化前端 (React 18):

  • Vite 构建工具提供了秒级的冷启动体验。
  • TanStack Router 实现了类型安全的路由管理,TanStack Query 优雅地处理了服务端状态与缓存。
  • Mantine v7 组件库构建了统一且美观的 UI 界面,配合 TypeScript 保证了代码的健壮性。

四、实际应用价值

在 SmartCampus NetManager (SCNM) 这样的大型园区网络管理软件开发中,SMS 展现了显著价值:

  • 消除认知偏差:后端看着 SMS 的 API 写接口,前端看着 SMS 的 UI 写界面,测试看着 SMS 的操作步骤写用例,所有人都基于同一份数据工作。
  • 加速 QA 流程:通过结构化数据投喂 AI,原本需要 3 天编写的测试用例代码,现在仅需数分钟生成并微调。
  • 资产沉淀:项目结束后,SMS 中留存的不仅仅是代码,而是包含了设计演变、接口决策和业务逻辑的完整数字资产。

SMS 不仅仅是一个文档管理工具,它是现代软件工程中连接人类智慧与 AI 生产力的关键纽带。

有类似需求?联系 微信 CorkineMa 免费获取建议和报价折扣。