在知乎看到一个问题:文档工程师的工作流程怎样的?怎样和技术人员沟通呢?
作为一个“不思进取”,长年耕耘IT行业的文档工程师,基于个人经验,简单做一个分享。
大家好,我是睿齐,一个技术传播者。
首先,个人认为,正如文档是产品的一部分,文档开发开发流程同样是产品研发流程的一部分。所以,将二者对比来看,完整的文档开发流程大体上是这样的:
其中,标识为黄色的部分,是需要文档工程师与研发团队进行信息交互的部分。
需求说明
参与需求说明评审会议,学习并参与讨论。关注文档开发中涉及的产品信息,包括但不限于:产品名称、产品架构、业务流程、典型应用场景、基本概念等,确认是否已包含,是否充分可支持后续文档开发,并且不存在疑问。接口人:产品经理
系统设计
参与系统设计评审会议,学习并参与讨论。关注文档开发中涉及的相关信息,包括但不限于:系统架构、功能架构、实现原理、概要设计、接口定义等,确认是否已包含,是否充分可支持后续文档开发,并且不存在疑问。接口人:系统设计工程师/研发主管
文档设计
基于系统设计,输出文档内容架构设计,评审确认内容架构逻辑是否合理;内容是否充分满足交付需求;对前置信息的理解是否正确,包括但不限于产品定义/功能实现等,避免问题后置。接口人:产品经理/系统设计工程师/研发主管
说明:对于规模较大、涉及多人开发的文档,如果在开发过程中进行内容架构调整,可能造成较大代价。
文档开发
通过详细设计获取相关信息,包括但不限于API接口信息等。接口人:开发工程师
通过测试用例设计获取相关信息,包括但不限于操作步骤等。接口人:测试工程师
就文档开发过程中遇到的产品/技术问题进行确认。接口人:系统设计/开发/测试工程师
由于文档开发阶段,会与整个研发团队,进行比较密切的沟通,为了避免频繁、低效沟通,个人建议避免“一问一答”的提问方式,尽可能做到:查阅相关文档,尝试自行解决问题,或提升认知水位;汇总无法解决的问题;预约答疑时间;集中进行问题确认。
文档评审/测试/验证
针对文档评审/测试/验证过程中,各方反馈意见中存在疑问的部分,进行问题确认。接口人:系统设计/开发/测试工程师
真正好的沟通,并不存在放之四海而皆准的流程规范,需要结合文档开发的实际情况,灵活运用各种方法,以获取信息为目标,进行高效、双赢的沟通。
其他推荐:
实施:GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播
这次他们说好要“讲真的”| 传播
在座都别吵了,你们还有我| 技术传播
睿齐
技术传播从业者
品牌内容策划
自由摄影师
自由撰稿人
汪力迪
公众号:techcomm / htstory
微信号:bgrichi
邮箱:hash_0813@163.com