# 规范文档

DarkM 项目开发规范和最佳实践

# 文档概览

本章节包含 DarkM 项目开发的完整规范体系，涵盖项目管理、需求、开发、测试、安全、运维等各个方面。

# 规范体系

┌─────────────────────────────────────────────────────────────┐
│                      规范体系                                │
├─────────────┬─────────────┬─────────────┬─────────────────┤
│  管理规范    │  技术规范    │  安全规范    │  运维规范        │
├─────────────┼─────────────┼─────────────┼─────────────────┤
│ 项目管理规范 │ 开发规范     │ 安全规范     │ 运维规范         │
│ 需求管理规范 │ 编码规范     │             │                 │
│ 报价评估规范 │ 测试规范     │             │                 │
│             │ 开发方法论   │             │                 │
└─────────────┴─────────────┴─────────────┴─────────────────┘

1
2
3
4
5
6
7
8
9
10

# 规范清单

# 管理规范

规范	说明	适用场景
项目管理规范	项目全流程管理、角色职责、紧急事故处理	所有项目
需求管理规范	需求提出、评审、变更、验收	需求管理
报价评估规范	工作量评估、报价公式、风险评估	项目报价

# 技术规范

规范	说明	适用场景
开发规范	开发流程、代码规范、最佳实践	所有开发工作
编码规范	命名规范、代码风格、注释规范	代码编写
测试规范	测试流程、用例设计、缺陷管理	测试工作
开发方法论	传统开发、敏捷开发、方法论选择	项目规划

# 安全规范

规范	说明	适用场景
安全规范	安全设计、代码安全、认证授权、数据安全	所有开发工作

# 运维规范

规范	说明	适用场景
运维规范	部署流程、监控告警、数据备份、应急预案	系统运维

# 快速导航

# 按角色

角色	必读规范	选读规范
项目经理	项目管理规范、需求管理规范、报价评估规范	开发规范、测试规范
开发工程师	开发规范、编码规范、安全规范	项目管理规范、测试规范
测试工程师	测试规范、项目管理规范	开发规范、安全规范
运维工程师	运维规范、安全规范	项目管理规范、开发规范

# 按场景

场景	相关规范
新项目启动	项目管理规范、开发规范、安全规范
需求评估	需求管理规范、报价评估规范
代码开发	开发规范、编码规范、安全规范
测试验收	测试规范、项目管理规范
系统上线	运维规范、安全规范、项目管理规范
紧急事故	项目管理规范（紧急事故处理）、运维规范

# 规范使用原则

# 必须遵守

🔴 安全规范：涉及系统安全的规范必须严格遵守
🔴 编码规范：代码风格、命名规范必须统一
🔴 部署流程：上线部署必须按流程执行

# 建议遵守

🟡 开发规范：推荐遵循，提高代码质量
🟡 测试规范：推荐遵循，保证测试质量
🟡 文档规范：推荐遵循，便于知识传承

# 灵活调整

🟢 管理流程：小项目可简化流程
🟢 评估方法：可根据项目特点选择评估方法
🟢 工具选择：可根据团队习惯选择工具

# 规范更新

规范文档会持续更新，更新原则：

实践驱动：基于实际项目经验总结
持续改进：定期回顾优化规范
团队共识：重要变更团队讨论决定

# 相关资源

最后更新：2026-03-20