[探讨] 团队业务文档工作流
一、问题背景
- 在软件开发中为了赶进度，重心集中在功能开发/编码，对于文档的重视程度不高
- 项目完工后才开始编写接口文档，用户手册等，事前没有进行培训，内容分成几部分每人写一部分，风格/样式等都不一样，对阅读者的体验很差
- 文档命名/文件夹命名混乱，根据个人喜好进行命名，文档内容格式、排版也不相同
二、造成后果
：文档写完后，没人看，也看不懂，直接看代码，增加熟悉项目难度
三、如何建设团队文档文化？
3.1 如何建设文档工作流
- 明确目标和需求。包括管理的文档类型（ppt,word,md,excel）、创建和编辑流程、版本控制、访问权限等
- 选择合适的工具。需提供在线编辑、版本控制、权限（可读/写/审核）、实时协作、全局搜索（包括正则搜索）等
- 制定文档模板。包括标题、表头（版本，创建人，创建日期，修改人，修改日期，审核人，审核日期，内容说明，备注）、表格、段落格式、图表等
- 创建工作流程，定义文档的创建、编辑、审核和发布流程
- 设置访问权限
- 培训和推广。确保团队成员了解如何使用所选工具和流程
- 持续优化和改进
- 保持沟通
- 遵循公司/组织规章制度
3.2 文件夹如何命名
- 使用服务>功能命名，比如 '电商>订单'
1.1 比如01-设计 02-接口文档 03-事故调查报告 04-上线检查清单.... - 使用缩写或简写
- 使用统一格式，比如 '年份-月份-主题'
- 添加标签
- 使用字母和数字组合
- 考虑未来需求
- 定期审查和更新
3.3 文档如何命名
- 文档主题
- 日期信息。反映文档的创建/最后修改日期
- 序号。对同一类别的文档，可使用序号进行区分和排序
- 版本控制。对于一个文档多次更新只保留最新的还是收拢为一个文件夹
4.1 可以把文件夹放置一段时间（比如一周/一月），在这个时间段没人变更就放入历史数据中 - 作者和负责人
- 关联文档
参考：文心一言
