话题动态
发起者
一步梅
话题状态
等待首个回复
参与人
1
互动热度
0
前端项目一旦做大,最让人头疼的不是写 RFC(Request for Comments),而是半年后新人入职,发现「方案里写了一套,代码里跑的是另一套」。
文档脱节的本质,是方案评审脱离了代码的生命周期。写文档出身的我,目前在团队里推行了这样 3 步流转:
/rfcs 文件夹下。main 分支;如果开发中架构有变动,PR 必须同时包含「代码修改」和「RFC 补丁」,否则不予合并。[Draft] -> [Accepted] -> [Implemented] -> [Deprecated]。上线后归档为静态记录,日常维护则转交给代码注释和 TS 类型。但实际执行中还是有痛点:业务排期一紧,大家往往「先上线,文档下周补」,最后下周复下周,RFC 依然有失效的风险。
想请教各位前端负责人和架构师: 大家团队目前是用什么机制防脱节的?是有成熟的 CI 检查或工具链约束,还是索性「RFC 只管立项,事后脱节就随它去,靠自动生成的代码文档活着」?欢迎分享你们的实践。
全部回复(0)