From aee4c0f19518e454a1870ecf3102b01ce8b15103 Mon Sep 17 00:00:00 2001 From: rand777 Date: Sat, 15 Mar 2025 04:59:29 +0800 Subject: [PATCH] docs: finish proj name standard --- .../项目文档/1.规范性文件/项目命名规范.md | 152 +++++++++++++++++- 1 file changed, 150 insertions(+), 2 deletions(-) diff --git a/docs/notes/项目文档/1.规范性文件/项目命名规范.md b/docs/notes/项目文档/1.规范性文件/项目命名规范.md index e927e6b..613c192 100644 --- a/docs/notes/项目文档/1.规范性文件/项目命名规范.md +++ b/docs/notes/项目文档/1.规范性文件/项目命名规范.md @@ -5,7 +5,155 @@ permalink: /project-docs/standards/name-project/ icon: mdi:rename --- -:::info 文件命名规范V1.0.1 -仅供参考 +:::info 文件命名规范V1.4.5 +Release Date: 2025-03-15 ::: +这里的所有规范都是为了帮助同学们更好地进行项目管理，所以请耐心看完哦。 + +## 文件命名规范 + +赛事主办方未给出命名规范、项目仍在建设时、正式向主办方提交材料前采用下面的命名规范，比赛名称简写表参考[附录](/project-docs/standards/name-project/#比赛名称简写表) + +### 参赛文件命名 + +包括 :[vscode-icons:file-type-powerpoint2]:PPT、:[vscode-icons:file-type-word]: +Word、:[vscode-icons:file-type-excel]:Excel、:[tabler:tex]:TeX或其.zip包、:[logos:adobe-icon]: +Adobe系列工程文件 + +> 【{项目文件简写} {文件目的阐述} {比赛名称简写}】+日期（yyyy-mm-dd）+ 版本号 + +如 `【植愈 正式答辩用 大创赛】2025-03-15 V2.0.0R.pptx` + +如果是科创部等部门需要我们提交的文件而没有具体的命名规范，则只需在`原文件名`前加上【比赛名称简写】和【具体项目名称】，例如： +`【小挑】【植愈-情绪管理好伙伴】附件2第十四届“挑战杯”大学生创业计划竞赛申报表` + +### 其他相关文件 + +如果参赛时要求提交补充材料，且不在参赛文件命名的类型文件中，按这种方式命名： + +> 【{文件目的阐述}】日期（yyyy-mm-dd）+ 版本号 + +如 `【后端系统架构设计UML】2025-03-15 V2.0.4` + +## 版本命名规范 + +### 版本迭代规范 + +遵循【a.b.c】的原则 + +--- + +#### 版本迭代说明消息 + +:::important +`c级别`更改不附带消息，每次`b级别`及以上版本更迭，需在项目群内附带消息，说明在什么地方进行了更改，更改目的是什么。 +::: + + +> 附带消息示例： +> +> 【迭代说明】【植愈 正式答辩 大创赛】2025-03-15 V1.2.16.pptx: 在第8页增加了《白皮书》的参考链接，第10页添加了调研结果。 + +:::tabs + +@tab:[vscode-icons:file-type-powerpoint2]:PPT + +- c级别变化：单张PPT 内容变化或简单的顺序调整，1.00=>1.01 +- b级别变化：大幅度内容更换，1.0.0=>1.1.0，需附带**版本迭代说明消息**。组内所有成员和指导老师们审核后，生成发行版用于答辩等 +- a级别变化: V1.6.6=>V2.0.0R`（这里的R表示Release，用于标识发行版）`，需附带**版本迭代说明消息** + 。==生成配套.pdf文件并且 ppt需嵌入字体文件，检查WPS Office和Microsoft Office的兼容性==。 + +@tab:[vscode-icons:file-type-word]:Word + +- c级别变化：章节以下级别内容变更，1.0.0=>1.0.1 +- b级别变化：大幅度内容变更，1.00=>1.10，需附带**版本迭代说明消息**。 +- a级别变化：组内所有成员和指导老师们审核后，生成发行版用于答辩等，1.6.6=>2.0.0R + `（这里的R表示Release，用于标识发行版）`，需附带**版本迭代说明消息**。 + +@tab:[tabler:tex]:TeX +写入到`version.md`文件中，附带版本说明，例如: + +> V1.0.4: add the content of subsectionA +> +> V1.1.2: add new sectionB +> +> V2.0.0R: Psychological Therapy Thesis Release 1 finished. [Hou Revised] + +- c 级别变化：main.tex｜.cls 文件序言区、章节级别内容调整，1.00=>1.01; +- b 级别变化：article 和 thesis 文件 chapter 级别以上，book 文件 subsection 级别以上; +- a 级别变换：指导老师审核通过后，生成发行版文件，2.3.3=>3.0.0R + +::: +审核同学或指导老师们审核完成后，需要在文件名称前加上【拼音简写】+【已审】，以赵帅【ZS】举例: + +> 【ZS 已审】【植愈 正式答辩 大创】2025-03-15 V4.12.10.pptx：按照要求检查了PPT中的字体、Office兼容性问题，无异常。 + +有需要更改的地方，请使用批注功能说明更改建议。 + +### 软件开发版本规范 + +> V【a.b.c】.yyyymmdd_【希腊字母版本号】 +> +> V{a.b.c}和[版本迭代规范](/project-docs/standards/name-project/#版本迭代规范)一致 + +:::details 适用于 +* git代码库版本 +* 数据库版本 +* 需求文档版本 +* 需求变更文档版本 +* 设计文档版本 +* 开发文档版本 +* 测试计划版本 +* 操作手册版本 +* 测试用例版本 +* 测试报告版本 +* 版本发布内容 +* 迭代总结版本 +* docker镜像版本 +* pom版本 +::: + +举个例子 + +> V1.0.0.20250315_base + +解读一下这个版本号命名规范： + +第一位：版本前缀（V1.0.0.20250315_base） +> V（version）英文版本的缩写 + +第二位：主版本号（V1.0.0.20250315_base） +> 当功能模块有较大的变动，比如增加模块或是整体架构发生变化。此版本号由项目经理决定是否修改。 + +第三位：副版本号（V1.0.0.20250315_base） +> 当功能有一定的增加或变化，比如增加了对权限控制、增加自定义视图等功能。此版本号由项目经理决定是否修改。 + +第四位：修订版本号（V1.0.0.20250315_base） + +> 一般是 Bug 修复或是一些小的变动，要经常发布修订版，时间间隔不限，修复一个严重的bug即可发布一个修订版。此版本号由项目经理决定是否修改。 + +第五位：日期版本号（V1.0.0.20250315_base） + +> 用于记录修改项目的当前日期，每天对项目的修改都需要更改日期版本号。此版本号由开发人员决定是否修改。 + +第六位：希腊字母版本号（V1.0.0.20250315_base） + +> 希腊字母版本号共有五种，分别为base、alpha、beta 、RC 、Release + +- Base： 此版本表示该软件仅仅是一个假页面链接，通常包括所有的功能和页面布局，但是页面中的功能都没有做完整的实现，只是做为整体网站的一个基础架构。 +- Alpha ： 软件的初级版本，表示该软件在此阶段以实现软件功能为主，通常只在软件开发者 内部交流，一般而言，该版本软件的Bug较多，需要继续修改，是测试版本。测试人员提交Bug经开发人员修改确认之后，发布到测试网址让测试人员测试，此时可将软件版本标注为alpha版。 +- Beta ： 该版本相对于Alpha 版已经有了很大的进步，消除了严重错误，但还需要经过多次测试来进一步消除，此版本主要的修改对象是软件的UI。修改的的Bug 经测试人员测试确认后可发布到外网上，此时可将软件版本标注为 beta版。 +- RC ： 该版本已经相当成熟了，基本上不存在导致错误的Bug，与即将发行的正式版本相差无几。 +- Release： 该版本意味“最终版本”，在前面版本的一系列测试版之后，终归会有一个正式的版本，是最终交付用户使用的一个版本。该版本有时也称标准版。 +## 附录 + +### 比赛名称简写表 + +| 比赛名称 | 比赛名称简写 | +|------------------|--------| +| 中国国际大学生创新大赛 | 大创 | +| “挑战杯”大学生课外学术科技竞赛 | 大挑 | +| “挑战杯”中国大学生创业计划大赛 | 小挑 | +| 中国计算机设计大赛 | 中计赛 | +| 中国大学生5分钟科研演讲比赛 | 科研演讲赛 |