星辰工作室(STARS)开发守则
一、核心准则
1. 用户价值优先:所有开发围绕真实需求展开,拒绝为了炫技堆砌无用功能,每一行代码都要为用户体验和业务价值负责。
2. 敬畏技术质量:把代码质量当成工作室的生命线,不接受“能跑就行”的敷衍,为每一段可复用的逻辑留下清晰的维护入口。
3. 开放协作共赢:承认个人认知的边界,主动同步进度、暴露问题,不卡项目、不藏信息,让协作效率成为团队的核心竞争力。
4. 保持探索热情:鼓励尝试前沿技术,但不盲目追逐热点,所有技术选型要匹配项目周期、团队能力和长期维护成本。
5. 诚信开发技术:不抄别人代码,尽量不使用AI,借用代码标注作者
二、需求开发规范
1. 需求确认不猜题:拿到需求先对齐背景、目标和验收标准,模糊的需求不启动开发,若需求变更必须同步更新文档并确认排期。
2. 设计先行再编码:核心功能必须先输出方案设计(包括数据结构、核心流程、接口定义),经团队评审通过后再进入开发环节,避免返工。
3. 自测闭环再提测:开发完成后必须先完成功能自测、边界用例测试和兼容测试,不把明显的问题留给测试和下游团队。
三、代码编写规范
1. 可读性优先于复杂度:变量、函数、类命名清晰见义,避免不必要的“黑话”和晦涩缩写,单函数只做一件事,代码行数尽量控制在一屏以内。
2. 注释写清“为什么”而非“做了什么”:逻辑不变更不修改注释,复杂业务逻辑和特殊的兼容处理必须留下清晰的说明,方便自己也方便后续维护的同事。
3. 提交前做代码自查:每一次代码提交都对应明确的功能或修复点,不提交和当前需求无关的代码,提交信息清晰描述修改内容,方便后续追溯问题。
4. 及时重构不积债:发现冗余、混乱的代码及时重构,不把技术债留给下一个人,也不因为“不是我写的”就放任问题存在。
四、协作沟通规范
1. 同步进度不拖延:每日主动更新项目进度,遇到阻塞风险提前1天同步,不隐瞒问题导致项目延期。
2. 代码评审坦诚开放:评审他人代码对事不对人,提问题同时给出优化建议;接受评审不玻璃心,有不同观点主动沟通,达成共识后及时调整。
3. 线上问题不推诿:不管是谁负责的模块,遇到线上问题先协同定位止损,再复盘追溯责任,不旁观、不甩锅。
五、上线与维护规范
1. 上线前做充分准备:核心功能上线必须准备回滚方案、应急预案,提前告知相关协作方,不做无准备的盲发。
2. 线上问题复盘到位:出现问题后先解决再复盘,输出明确的改进方案,避免同类问题重复发生。
3. 维护项目善始善终:接手的项目不烂尾,离职或转项时必须留下完整的交接文档,对接到位再移交,不留下没人管的“孤儿项目”。