一、文档管理规范(核心基础)
1.1 文档创建时机
新项目开发启动时,必须优先创建「说明文档.md」,作为项目全生命周期唯一管理载体。
1.2 文档核心内容
需包含项目规划、实施方案、进度记录三大模块,且内容需明确、可落地(如进度需标注具体时间节点)。
1.3 文档更新要求
- 每次重新打开项目前,必须先阅读「说明文档.md」,确认当前进度与要求后再启动开发;
- 项目计划调整、进度节点变更时,需即时更新文档对应模块;
- 每完成一项工作任务(如一个功能开发、一个 BUG 修复),需立即在文档进度记录中标记完成并补充结果说明。
二、开发流程规范(过程管控)
2.1 任务管理逻辑
采用(顺序化思考)分析需求,拆解为可执行的 ToDoList,明确任务优先级与依赖关系。
2.2 任务执行闭环
严格按 ToDoList 顺序执行,完成一项任务后,需在文档及任务清单中标记 “已完成”,确认无遗留问题后,再启动下一项任务,直至全量完成。
三、问题解决规范(技术支撑)
3.1 问题处理优先级
开发中遇到技术问题时,优先通过工具查找最新文档、代码示例,尝试解决问题。
3.2 官方文档依赖
若未解决问题,必须查找对应编程语言的官方文档(如 Python 查 Python.org、Java 查 Oracle 官方文档、Go 查 Go 官方文档),严禁自行编造代码或解决方案,确保技术方案的准确性与合规性。
四、执行约束规范(硬性要求)
4.1 三大 “绝不允许” 原则
- 绝不允许项目延期:严格按文档规划的时间节点执行,提前识别风险并调整计划(需同步更新文档);
- 绝不允许超出计划:开发范围、资源投入需严格匹配文档中的项目规划,若需扩容需先更新规划并确认可行性,严禁无规划扩展;
- 绝不允许出错:开发过程中需多轮自检(如代码编译检查、功能测试),若出现错误需立即暂停并按问题解决规范处理,修复后需验证无误再推进。
五、环境与输出规范(基础保障)
5.1 开发环境统一
固定使用 Windows 系统进行 TRAE 编程开发,确保环境一致性,避免跨系统兼容性问题。
5.2 代码输出标准
生成代码时,必须为所有函数添加函数级注释(需包含功能描述、参数说明、返回值类型及用途),提升代码可读性与可维护性。