核心原则
始终以最少的代码实现最优方案。
优先保证:
- 逻辑清晰
- 架构简单
- 工作流完整闭环
- 易于维护
- 易于理解
- 符合真实使用场景
避免:
- 过度设计
- 冗余抽象
- 无意义封装
- 为未来假设需求预留大量代码
- 多套重复实现方案
方案设计规范
设计方案时必须:
- 优先选择最简单可行方案
- 优先减少系统复杂度
- 优先减少依赖数量
- 优先减少维护成本
- 优先保证长期可迭代性
要求:
- 一个问题只保留一个最佳方案
- 避免多个并行实现
- 避免大量兜底逻辑
- 避免同一功能出现多套实现路径
- 保证流程天然闭环
Bug 处理规范
发现问题时:
禁止:
- 猜测原因
- 经验判断
- 通过增加补丁掩盖问题
- 堆叠防御性代码
必须:
- 阅读当前真实代码
- 分析实际执行流程
- 定位准确根因
- 验证根因是否成立
- 给出最小修复方案
修复要求:
- 直接解决根因
- 不引入额外复杂度
- 不增加无意义兼容逻辑
- 不增加重复状态管理
- 不增加临时补丁代码
代码实现规范
代码必须:
要求:
- 删除无用代码
- 删除废弃逻辑
- 删除重复实现
- 删除历史遗留兼容代码
禁止:
- Copy-Paste 实现
- 重复工具函数
- 重复状态维护
- 无意义包装层
- 无意义配置项
新增实现时:
- 检查旧实现是否还能保留
- 可以替代时直接移除旧实现
- 保持系统持续收敛
迭代维护规范
每次迭代必须:
- 新增功能
- 清理历史遗留代码
- 清理废弃接口
- 清理无效配置
- 清理无用依赖
目标:
系统随着迭代越来越简单,而不是越来越复杂。
第三方库使用规范
使用第三方库前必须:
- 阅读当前最新源码
- 阅读当前版本文档
- 阅读实际实现逻辑
- 阅读公开 API
禁止:
- 根据旧文章判断
- 根据博客判断
- 根据历史经验判断
- 根据过时文档判断
分析结论必须基于:
不得进行幻想式推测。
代码分析规范
分析项目时必须:
优先依据:
- 当前仓库最新代码
- 当前实际实现
- 当前调用链
- 当前运行逻辑
禁止:
- 根据 README 猜实现
- 根据项目简介猜实现
- 根据历史版本猜实现
- 根据同类项目猜实现
结论必须能够对应到实际代码位置。
架构规范
架构设计要求:
- 模块职责单一
- 模块边界清晰
- 调用关系简单
- 数据流明确
避免:
优先:
简单架构 > 复杂架构
可维护性 > 理论完美性
UI 规范
UI 设计要求:
优先:
避免:
真实场景原则
所有实现必须符合真实使用场景。
禁止:
- 为极低概率情况增加大量代码
- 为理论风险增加复杂逻辑
- 为假设场景增加实现
优先解决:
- 用户真实会遇到的问题
- 线上真实出现的问题
- 当前业务实际需求
输出要求
提供方案时:
- 直接给出最佳方案
- 明确说明原因
- 明确说明取舍
- 明确说明影响范围
避免:
如果能够确定最佳方案,则直接推荐最佳方案。
遵循:
最少代码、最小复杂度、最佳维护性、真实场景优先、根因驱动修复、持续合理收敛架构。