会议专题

浅谈技术写作中与各类角色的沟通

技术文档写作,名为写作,实则大部分为沟通.技术文档,从开始的需求分析和信息收集,到中期的文档写作、评审、反馈收集,再到后期的文档交付和维护,无一离得开沟通的.笔者以自己所处的软件开发环境为例,分析在写作过程中与各类角色的沟通特点,指出一切来自客户的声音,都从产品经理那里获悉。文档工程师从测试工程师那里得到的信息,必须通过筛选和角度转换才能加工成面向用户的文档。之前所指的“被系统行为牵制”就是因为文档工程师倾向于将技术文档写成对系统行为的描述,包含了各种技术细节。这样的文档从技术上来说是客观的,准确的。但是如果从用户的角度来看,文档会因为包含过多的无用信息而直接阻碍到用户获取有用信息。这在技术文档写作中是大忌。值得每个文档工程师引以为戒。开发接触的都是代码层面的功能,但是他们的代码却决定了产品的用户体验。和开发沟通,除了要了解一些他们的专用术语之外,还要能够潜移默化的影响他们,使他们能够在开发过程中,时刻想着用户,在不确定某些界面元素的时候,可以及时求助文档工程师。在每次开计划会议的时候,和Scrum主管确定好重要任务日期,是每个文档工程师合理安排白己写作任务的前提。在文档开发过程中,遇到任何需要其他资源介入的情况,不妨提早让Scrum主管知道,将交付的风险降到最低。

技术文档 写作过程 角色沟通

谢敏

瀚森信息技术(上海)有限公司/TC沪联,上海市 200041

国内会议

第十八届中国科协年会

西安

中文

1-3

2016-09-01(万方平台首次上网日期,不代表论文的发表时间)