软件行业 Release 包与升级内容命名与文件夹规范

适用于一粒云及合作方的所有软件产品交付、内部测试包、客户升级包、补丁包等文件管理。


1. 文件夹结构总览

产品发布/
├─ 01_Release_正式版/
│   ├─ V1.0.0_20251103/
│   │   ├─ Build/
│   │   │   ├─ Backend/
│   │   │   ├─ Frontend/
│   │   │   └─ Installer/
│   │   ├─ Docs/
│   │   │   ├─ ReleaseNote_V1.0.0.md
│   │   │   ├─ InstallationGuide_V1.0.0.pdf
│   │   │   ├─ UpgradeManual_V1.0.0.pdf
│   │   ├─ Scripts/
│   │   │   ├─ DB_Update/
│   │   │   ├─ Migration/
│   │   │   └─ Patch/
│   │   ├─ Tools/
│   │   └─ License/
│   ├─ V1.1.0_20251210/
│   └─ ...
├─ 02_Release_RC测试包/
│   ├─ RC1_20251020/
│   ├─ RC2_20251028/
├─ 03_Patch_补丁包/
│   ├─ V1.0.0_P1_20251115/
│   └─ V1.0.0_P2_20251202/
├─ 04_Upgrade_升级包/
│   ├─ V1.0.0_to_V1.1.0_20251210/
│   └─ V1.1.0_to_V1.2.0_20260201/
├─ 05_Hotfix_紧急修复/
│   ├─ HF_20251108_SQLFix/
│   ├─ HF_20251110_APIAuth/
└─ 06_Backup_归档/
    ├─ 每次发布的完整打包备份

2. 文件与包命名规则

(1)正式发布包命名

[产品名称]_Release_V[主版本号].[次版本号].[修订号]_[日期]

示例:

YLYCloud_Release_V1.0.0_20251103.zip
SmartRAG_Release_V2.1.0_20251201.tar.gz

(2)测试与候选版本命名(RC / Beta)

[产品名称]_RC[序号]_V[版本号]_[日期]
[产品名称]_Beta_V[版本号]_[日期]

示例:

YLYCloud_RC2_V1.0.0_20251028.zip
AIInsight_Beta_V0.9.1_20251012.zip

(3)补丁包命名

[产品名称]_Patch_V[主版本号].[次版本号]_P[补丁号]_[日期]

示例:

YLYCloud_Patch_V1.0_P1_20251115.zip

(4)升级包命名

[产品名称]_Upgrade_V[旧版本]_to_V[新版本]_[日期]

示例:

YLYCloud_Upgrade_V1.0.0_to_V1.1.0_20251210.zip

(5)紧急修复包(Hotfix)

[产品名称]_HF_[日期]_[修复模块]

示例:

YLYCloud_HF_20251108_DBIndexFix.zip

3. 每个版本包必须包含的文件

文件名内容说明
ReleaseNote_VX.X.X.md发布说明,包括新增功能、修复列表、兼容性变化
InstallationGuide_VX.X.X.pdf安装指南(分Windows/Linux)
UpgradeManual_VX.X.X.pdf升级步骤说明
RollbackGuide_VX.X.X.pdf回退说明(可选)
VersionInfo.json系统自动读取的版本配置
checksum.txt包文件的完整性校验信息(MD5/SHA256)
License.txt许可证说明
build.log构建日志(供回溯)

4. ReleaseNote 模板(Markdown 格式)

# Release Note - 一粒云文档云 V1.0.0
发布日期:2025-11-03  
构建版本号:1.0.0  
构建环境:Linux + Node 20 + .NET 8  

---

## 🆕 新增功能
- 新增文件AI分类功能
- 支持Markdown智能分段与检索
- 增加在线PDF转Word功能

## 🔧 修复内容
- 修复文件预览空白的问题
- 优化索引服务稳定性

## ⚙️ 兼容性变化
- 前端最低浏览器要求:Chrome 100+
- 不再支持旧版Node 16环境

## 🧩 部署说明
1. 备份数据库与`/data`目录;
2. 执行`/Scripts/DB_Update/20251103.sql`;
3. 替换`/api`与`/ui`目录;
4. 重启服务。

## 📦 附录
- 安装包:YLYCloud_Release_V1.0.0_20251103.zip  
- 校验码:`SHA256: 5acb2d12f...`

5. 升级包结构规范

YLYCloud_Upgrade_V1.0.0_to_V1.1.0_20251210/
├─ UpgradeManual_V1.1.0.pdf
├─ DB_Scripts/
│   ├─ 20251210_UpdateSchema.sql
│   ├─ 20251210_AddIndex.sql
├─ Backend/
│   ├─ bin/
│   └─ config/
├─ Frontend/
│   └─ dist/
├─ Tools/
│   ├─ upgrade.sh
│   └─ rollback.sh
├─ VersionInfo.json
└─ checksum.txt

注意事项:

  • 升级包必须可回退;
  • 变更数据库结构的脚本需带“安全回退”版本;
  • 每次发布后将包上传到公司 一粒云文档云 / 产品发布库
  • 发布流程必须由开发、测试、实施三方签字确认。

6. 内部规范配套措施

  1. 所有正式发布包由“产品负责人 + QA + 实施经理”三方签字确认。
  2. 每次发布均需自动生成 VersionInfo.jsonchecksum.txt,支持自动校验。
  3. 一粒云文档云后台应配置“版本发布管理模块”,统一归档。
  4. 内部开发环境、客户版本库、测试服务器保持命名一致。
  5. 版本号管理遵循 语义化版本控制(SemVer 2.0)
    • 主版本号(Major):有不兼容变更;
    • 次版本号(Minor):兼容新增;
    • 修订号(Patch):兼容修复。

一粒云企业文件与文件夹命名规范(v1.0)


一粒云企业文件与文件夹命名规范(v1.0)

适用范围:制造业、软件开发、工程管理类企业
目标:让文件“看名识内容”,便于全员协作、AI检索与归档自动化。


一、命名规范的总体原则

  1. 统一格式:所有文件夹、文件名均采用统一命名格式,避免同义词、随意缩写。
  2. 时间在前:重要文档命名中日期前置,利于排序与追溯。
  3. 模块化结构:文件命名由若干字段构成,字段间使用 _- 分隔。
  4. 禁止特殊字符:禁止使用 \/:*?"<>| 等系统保留字符。
  5. 可机器解析:为便于系统索引与AI识别,应使用半角字符与固定字段位置。
  6. 关键字段不省略:部门、项目、阶段、版本、日期、作者等必须齐全。

二、通用命名结构模板

[业务线]_[项目/产品]_[内容类型]_[阶段/版本]_[日期]_[负责人/部门]

示例:

制造部_汽车电机开发_样品测试报告_V2_20251103_王工.docx
软件部_智能文档云_前端开发说明_V1.2_20251101_李俊.md
工程部_机场改造项目_施工进度日报_20251102_周强.xlsx

三、文件夹层级结构与命名规则

(1)制造业文件夹结构建议

制造部/
├─ 01_设计开发/
│   ├─ CAD图纸/
│   ├─ 设计方案/
│   ├─ 样品记录/
├─ 02_生产工艺/
│   ├─ 工艺卡/
│   ├─ 操作手册/
│   ├─ 设备参数/
├─ 03_质量检验/
│   ├─ 检验报告/
│   ├─ 不良记录/
│   ├─ 改进方案/
├─ 04_供应链/
│   ├─ 采购清单/
│   ├─ 供应商档案/
│   ├─ 合格证/
├─ 05_项目档案/
│   ├─ 客户资料/
│   ├─ 合同文件/
│   ├─ 发票与验收/

制造业文件命名规则:

[产品型号]_[工艺/环节]_[内容类型]_[日期]_[负责人]

示例:

A13电机_冲压工艺_操作规程_20251025_陈强.docx
B24电机_质量检验_抽检报告_20251028_黄敏.xlsx

(2)软件开发文件夹结构建议

软件部/
├─ 01_需求与设计/
│   ├─ PRD_产品需求文档/
│   ├─ UI_设计稿/
│   ├─ 原型图/
├─ 02_开发代码/
│   ├─ 前端/
│   ├─ 后端/
│   ├─ API文档/
├─ 03_测试与发布/
│   ├─ 测试用例/
│   ├─ Bug清单/
│   ├─ 发布说明/
├─ 04_项目资料/
│   ├─ 合同/
│   ├─ 沟通纪要/
│   ├─ 交付记录/

软件开发文件命名规则:

[系统名称]_[模块]_[内容类型]_[版本号]_[日期]_[作者]

示例:

YLYCloud_文件管理_接口文档_V1.1_20251103_李伟.docx
RAG搜索_前端UI_迭代需求_V0.9_20251031_王珊.xlsx

(3)工程管理文件夹结构建议

工程部/
├─ 01_项目立项/
│   ├─ 可研报告/
│   ├─ 立项批文/
│   ├─ 合同文件/
├─ 02_施工管理/
│   ├─ 图纸设计/
│   ├─ 材料清单/
│   ├─ 日报周报/
├─ 03_监理与验收/
│   ├─ 监理记录/
│   ├─ 验收报告/
│   ├─ 问题整改/
├─ 04_结算归档/
│   ├─ 付款申请/
│   ├─ 发票收据/
│   ├─ 档案汇总/

工程管理文件命名规则:

[项目简称]_[分项/阶段]_[文件类型]_[日期]_[负责人]

示例:

兰州数据中心_弱电工程_进度汇报_20251101_刘志强.docx
渤海支行改造_材料清单_V1_20251029_赵婷.xlsx

四、命名中的关键字段说明

字段说明取值建议
业务线公司部门或板块,如制造部、软件部、工程部固定列表
项目/产品项目名称或产品型号使用简短规范缩写
内容类型报告、方案、需求、设计、说明、测试等固定分类
阶段/版本如 V1.0、V2.3 或 Alpha/Beta/正式版使用统一格式
日期YYYYMMDD确保系统排序一致
负责人姓名或拼音缩写方便责任追溯

五、命名规范实施建议

  1. 建立公司统一模板库(文件夹结构 + 空模板文件),由一粒云文档云同步到所有项目。
  2. 每月抽查命名规范合规率,并在周会上通报。
  3. AI辅助命名:在系统中引入命名自动提示和纠错机制。
  4. 文件归档时强制命名检查,未命名规范不得提交归档。