返回

博客文章

我怎么给一个现成项目整理开发规则

不是从抽象原则开始,而是从目录、模块边界、已有写法和高频协作问题开始,把规则做成真的能被使用的东西。

工程规范2025-054 分钟

给一个全新项目立规则,和给一个已经跑了一段时间的现成项目整理规则,其实是两件完全不同的事。

新项目可以从理想状态开始设计,但现成项目不一样。它已经有目录、已经有历史写法、已经有一部分团队默契,也已经有很多“不够完美但暂时还在用”的现实。

所以我现在给现成项目整理开发规则,通常不会从抽象原则开始,而是先从项目真实长什么样开始。

第一步:先看项目是怎么活下来的

我不会一上来就写“命名规范”“组件规范”“目录规范”,而是先看这个项目现在到底怎么运行。

比如:

  • 目录是怎么分层的
  • 页面和组件是怎么组织的
  • 通用逻辑有没有沉淀
  • API 调用习惯是什么
  • 状态管理有没有固定方式
  • 是否存在明显的历史包袱
  • 团队最容易在哪些地方写乱

这些信息比一套通用规范更重要。因为规则不是为了看起来完整,而是为了和这个项目的现实对上。

第二步:优先整理高频出错点

我一般不会追求一次性把所有规则都补全,而是优先整理那些最容易反复出错的点。

比如:

  • 新页面总有人放错目录
  • 接口层总有人绕过统一封装
  • 样式命名风格经常不一致
  • 公共组件被反复复制
  • AI 输出总喜欢引入不该用的写法
  • 改一个模块时经常误伤别的逻辑

这些地方最值得先写规则。因为它们不是理论上重要,而是真实协作中已经持续消耗成本的问题。

第三步:规则要和项目上下文绑定

我越来越不喜欢那种脱离项目的“万能规则”。因为看起来很全,实际用起来很难落地。

真正有用的规则,应该尽量贴着当前项目写。比如不是泛泛地说“遵循现有技术栈”,而是明确说:

  • 当前项目使用 Vue3 + Vite,不要引入 Vue2 写法
  • 页面放在什么目录,公共组件放在哪里
  • 新增接口时优先复用现有请求封装
  • 有同类页面时先参考哪个模块
  • 修改前先判断是通用逻辑还是业务特例

这种规则看起来没那么“高大上”,但更容易被执行。

第四步:规则最好能直接参与协作

我现在会很在意一件事:规则是不是只存在于文档里,还是已经能真正参与协作。

比如它能不能直接被拿去作为 AI 提示词的一部分,能不能作为新成员入项资料,能不能在 Code Review 里作为判断依据,能不能帮助大家在遇到分歧时快速对齐。

如果规则只是“写完放那儿”,那它很容易慢慢失效。只有当规则真正嵌进日常协作里,它才会活起来。

第五步:规则不是越多越好,而是越清楚越好

很多人整理规则时容易走向另一个极端:写很多,非常细,非常全。

但我自己的感受是,规则最重要的不是多,而是清楚。一条模糊的规则,写十遍也没用;一条足够具体的规则,往往更能真正减少分歧。

所以我更倾向于写那些可以直接执行、直接判断、直接复用的内容,而不是停留在大而泛的正确表达上。

结语

给现成项目整理规则,不是重新发明一套理想工程体系,而是把这个项目已经形成的现实,整理成更清晰、更可协作的表达。

对我来说,好的规则不是“看起来专业”,而是“真的有人会照着用”。只要能减少理解成本、减少返工、减少误判,它就是有价值的。