平台规范列表

概述

序号	类型	规范名称	描述	备注
1	Java开发规范	代码风格规范	定义Java代码的命名规则、缩进、注释等规范
2		文档编写规范	规定Java代码文档的格式、内容和注释要求
3		测试规范	定义Java代码的单元测试、集成测试和性能测试规范
4		安全规范	规定Java代码中的安全编码实践，防止常见安全漏洞
5		性能规范	定义Java代码的性能优化策略和最佳实践
6	前端开发规范	HTML/CSS规范	定义HTML和CSS代码的命名规则、缩进、注释等规范
7		JavaScript规范	规定JavaScript代码的命名规则、代码风格、模块化等规范
8		测试规范	定义前端代码的单元测试、集成测试和性能测试规范
9		安全规范	规定前端代码中的安全编码实践，防止常见安全漏洞
10		Vue 3开发规范	定义Vue 3项目的代码结构、组件设计、状态管理等规范
11		Element Plus开发规范	规定使用Element Plus组件库的开发规范和最佳实践
12	数据开发规范	数据采集规范	定义数据采集的方式、数据源的选择和接入方式
13		数据处理规范	规定数据处理的流程、数据清洗、转换和集成的规则
14		数据存储规范	定义数据存储的策略和规则，包括数据分区、分桶、压缩、索引等
15		数据安全规范	规定数据的安全措施，包括数据加密、访问控制、身份认证等
16	数据治理规范	数据质量规范	定义数据质量标准和指标，确保数据的准确性、完整性等
17		数据分类和标记规范	规定数据分类和标记的方法和标准，以识别数据的敏感性和合规性
18		数据访问和权限规范	定义数据访问控制策略和权限管理规则，确保数据的安全性和隐私保护
19		数据备份和恢复规范	规定数据备份和恢复策略、周期和方法，确保数据的可靠性和可恢复性
20	数据治理规范	数据访问和权限规范	定义数据访问控制策略和权限管理规则，确保数据的安全性和隐私保护
21		数据备份和恢复规范	规定数据备份和恢复策略、周期和方法，确保数据的可靠性和可恢复性
22	运维管理规范	部署规范	定义应用程序的部署流程和规则
23		监控规范	规定系统监控指标和告警规则，以便进行系统状态监控和故障排查
24		容灾规范	定义容灾策略和规则，确保系统的高可用性和容错性
25	反向代理规范	反向代理配置规范	定义Nginx反向代理的配置规范，包括代理服务器的选择和配置
26		负载均衡配置规范	规定Nginx负载均衡的配置规范，包括负载均衡算法和服务器权重的设置
27		缓存配置规范	定义Nginx缓存的配置规范，包括缓存策略、过期时间和缓存清理规则
1	接口开发规范	接口命名规范	使用有意义的名词或动词短语来描述接口的功能。
2		请求方法规范	使用合适的HTTP请求方法，如GET、POST、PUT、DELETE等。	遵循API风格
3		URL设计规范	使用名词来表示资源，使用URL路径参数表示资源的唯一标识。	使用复数形式表示资源的集合
4		请求参数规范	使用合适的数据格式，使用明确的参数命名。	对必需参数进行验证
5		响应格式规范	使用合适的数据格式，返回合适的HTTP状态码。	包含必要的元数据
6		错误处理规范	定义合适的错误码和错误信息，提供详细的错误信息。	使用合适的HTTP状态码表示错误
7		安全性规范	使用合适的安全机制，防止常见的安全漏洞。
8		版本管理规范	在URL中包含版本号，适时引入新的版本。	提供向后兼容的策略
9		接口文档规范	编写清晰、详细的接口文档，使用统一的文档格式。	及时更新文档
1	Git版本管理规范	主分支管理规范	主分支用于发布稳定版本，禁止直接在主分支上进行开发。
2		分支管理规范	使用分支进行开发，每个功能或任务创建一个独立的分支。	使用语义化的分支命名
3		分支合并规范	使用合并或变基操作将功能分支合并到开发分支。	删除已合并的分支
4		版本标签规范	在发布稳定版本时，创建一个标签来标识版本号。	使用语义化版本号
5		远程仓库规范	使用远程仓库进行代码备份和协作开发。	定期推送本地代码到远程仓库
6		代码审查规范	提交前进行代码审查，确保代码质量和规范性。
7		本地测试规范	提交前进行本地测试，确保代码的功能和逻辑正确。
8		代码格式化规范	提交前进行代码格式化，保持代码风格的一致性。
9		提交信息规范	提交时编写有意义的提交信息，描述本次提交的目的和内容。	使用简洁明了的语句
10		分批提交规范	避免一次提交包含过多的修改，保持提交的原子性。
1	推理Prompt规范	清晰的问题陈述	在对话开始时，明确提出问题或指令，以引导ChatGPT生成相关的回答或响应。
2		上下文管理	在对话中保持一致的上下文，通过提供前面的对话历史，使ChatGPT能够理解问题的背景和相关信息。
3		限制回复长度	限制ChatGPT生成的回复长度，以避免过长的回复或无关的信息。
4		引导生成	使用明确的引导或提示，以指导ChatGPT生成特定类型的回答。
5		多轮对话	在多轮对话中，使用明确的对话标记或指令，以区分用户和ChatGPT的发言，并确保对话的连贯性。
6		修正和追问	如果ChatGPT的回答不符合预期或需要进一步解释，可以通过修正或追问来引导ChatGPT提供更准确或详细的回答。
7		多样性控制	根据需要，在生成回复时使用多样性控制参数（例如，temperature）来调整生成的创造性和多样性程度。
8		审查结果	对ChatGPT生成的结果进行审查，确保回答的准确性和合理性，并进行必要的编辑或修改。

序号	类型	称	描述	备注
1	Java开发规范	代码风格规范	定义Java代码的命名规则、缩进、注释等规范
2		文档编写规范	规定Java代码文档的格式、内容和注释要求
3		测试规范	定义Java代码的单元测试、集成测试和性能测试规范
4		安全规范	规定Java代码中的安全编码实践，防止常见安全漏洞
5		性能规范	定义Java代码的性能优化策略和最佳实践
6	前端开发规范	HTML/CSS规范	定义HTML和CSS代码的命名规则、缩进、注释等规范
7		JavaScript规范	规定JavaScript代码的命名规则、代码风格、模块化等规范
8		测试规范	定义前端代码的单元测试、集成测试和性能测试规范
9		安全规范	规定前端代码中的安全编码实践，防止常见安全漏洞
10		Vue 3开发规范	定义Vue 3项目的代码结构、组件设计、状态管理等规范
11		Element Plus开发规范	规定使用Element Plus组件库的开发规范和最佳实践
12	数据开发规范	数据采集规范	定义数据采集的方式、数据源的选择和接入方式
13		数据处理规范	规定数据处理的流程、数据清洗、转换和集成的规则
14		数据存储规范	定义数据存储的策略和规则，包括数据分区、分桶、压缩、索引等
15		数据安全规范	规定数据的安全措施，包括数据加密、访问控制、身份认证等
16	数据治理规范	数据质量规范	定义数据质量标准和指标，确保数据的准确性、完整性等
17		数据分类和标记规范	规定数据分类和标记的方法和标准，以识别数据的敏感性和合规性
18		数据访问和权限规范	定义数据访问控制策略和权限管理规则，确保数据的安全性和隐私保护
19		数据备份和恢复规范	规定数据备份和恢复策略、周期和方法，确保数据的可靠性和可恢复性
20	数据治理规范	数据访问和权限规范	定义数据访问控制策略和权限管理规则，确保数据的安全性和隐私保护
21		数据备份和恢复规范	规定数据备份和恢复策略、周期和方法，确保数据的可靠性和可恢复性
22	运维管理规范	部署规范	定义应用程序的部署流程和规则
23		监控规范	规定系统监控指标和告警规则，以便进行系统状态监控和故障排查
24		容灾规范	定义容灾策略和规则，确保系统的高可用性和容错性
25	反向代理规范	反向代理配置规范	定义Nginx反向代理的配置规范，包括代理服务器的选择和配置
26		负载均衡配置规范	规定Nginx负载均衡的配置规范，包括负载均衡算法和服务器权重的设置
27		缓存配置规范	定义Nginx缓存的配置规范，包括缓存策略、过期时间和缓存清理规则
1	接口开发规范	接口命名规范	使用有意义的名词或动词短语来描述接口的功能。
2		请求方法规范	使用合适的HTTP请求方法，如GET、POST、PUT、DELETE等。	遵循API风格
3		URL设计规范	使用名词来表示资源，使用URL路径参数表示资源的唯一标识。	使用复数形式表示资源的集合
4		请求参数规范	使用合适的数据格式，使用明确的参数命名。	对必需参数进行验证
5		响应格式规范	使用合适的数据格式，返回合适的HTTP状态码。	包含必要的元数据
6		错误处理规范	定义合适的错误码和错误信息，提供详细的错误信息。	使用合适的HTTP状态码表示错误
7		安全性规范	使用合适的安全机制，防止常见的安全漏洞。
8		版本管理规范	在URL中包含版本号，适时引入新的版本。	提供向后兼容的策略
9		接口文档规范	编写清晰、详细的接口文档，使用统一的文档格式。	及时更新文档
1	Git版本管理规范	主分支管理规范	主分支用于发布稳定版本，禁止直接在主分支上进行开发。
2		分支管理规范	使用分支进行开发，每个功能或任务创建一个独立的分支。	使用语义化的分支命名
3		分支合并规范	使用合并或变基操作将功能分支合并到开发分支。	删除已合并的分支
4		版本标签规范	在发布稳定版本时，创建一个标签来标识版本号。	使用语义化版本号
5		远程仓库规范	使用远程仓库进行代码备份和协作开发。	定期推送本地代码到远程仓库
6		代码审查规范	提交前进行代码审查，确保代码质量和规范性。
7		本地测试规范	提交前进行本地测试，确保代码的功能和逻辑正确。
8		代码格式化规范	提交前进行代码格式化，保持代码风格的一致性。
9		提交信息规范	提交时编写有意义的提交信息，描述本次提交的目的和内容。	使用简洁明了的语句
10		分批提交规范	避免一次提交包含过多的修改，保持提交的原子性。
1	推理Prompt规范	清晰的问题陈述	在对话开始时，明确提出问题或指令，以引导ChatGPT生成相关的回答或响应。
2		上下文管理	在对话中保持一致的上下文，通过提供前面的对话历史，使ChatGPT能够理解问题的背景和相关信息。
3		限制回复长度	限制ChatGPT生成的回复长度，以避免过长的回复或无关的信息。
4		引导生成	使用明确的引导或提示，以指导ChatGPT生成特定类型的回答。
5		多轮对话	在多轮对话中，使用明确的对话标记或指令，以区分用户和ChatGPT的发言，并确保对话的连贯性。
6		修正和追问	如果ChatGPT的回答不符合预期或需要进一步解释，可以通过修正或追问来引导ChatGPT提供更准确或详细的回答。
7		多样性控制	根据需要，在生成回复时使用多样性控制参数（例如，temperature）来调整生成的创造性和多样性程度。
8		审查结果	对ChatGPT生成的结果进行审查，确保回答的准确性和合理性，并进行必要的编辑或修改。