首发于 语雀文档@blueju
现状:
之前的文档都是原组长将撰写任务布置下去,由各组员自己撰写的,虽有提及写完后需评审,但实际上鲜有评审的,因此问题主要在两方面:
- 组长自己没事
- 组员没有提出和推进评审的意识(说实话,一般人还真难有)
计划:
我也不敢说自己就是对的,因此用“计划”这个词来代替我
个人认为,作为小组长,第一版文档应该有自己来撰写,后续的修改交给下属。
一是作为小组长,应该比其他人更首先清楚文档所描述对象的前因后果;
二是文档该怎么写不是下属他自己就能决定的,
三是后续的修改可以交给下属,但需要做到为他提供一下
四是人也是慢慢成长的,后续的改版修改可以让下属自己列出提纲让自己过目是否达到自己或者更高级领导想要的结果。
值得思考的点
我认为值得思考的点是:文档架构(说得技术了点)
像我们团队,涉及到的文档有基座权限操作指南、子应用开发指南、快速入门、子应用接入基座指南、前端 OSS 上传指南、ngfe-request 统一请求插件使用指南、前端开发规范手册、ngfe-permission 权限插件使用指南、ngfed 组件库文档等。
以上如此多的内容,倘若能好好梳理现有文档之间的关系及长远思考哪些可能新增的文档,抽离公共文档,以链接的方式关联,无需重复撰写,一处改动更新,也不失为团队的一种知识财富。