tcworld中国2017

中国技术传播领域专家和决策者的顶级盛事

25名来自国内和国际嘉宾的分享

他们将结合中国国内实际挑战提供解决方案

舒适的会场
静候你的到来

上海锦江汤臣洲际大酒店

研讨: 开发人员文档的Funktionsdesign® 方法

研发人员文档的需求日益增加。除了完整的参考信息,还需要解释性的易懂的文字。那么你是怎么做到的呢?最好把参数放进表格或列表?代码段最好用粗体或单空格字体?在哪里开始一个新的章节或段落?首页都放些什么信息来介绍整个教程?

在这个半天研讨中,我们在团队中使用多种方法来“设计”文档,目的是为了给团队某应用程序的API创建一份完备紧凑的开发人员文档。从用例、初步想法和整体构思,每一层都会产生文字。Funktionsdesign®会帮我编写具有很正意义的产品介绍、概念、功能和教程。如果时间允许,文档举例就可以反过来一层一层揭开,形式和功能就一览无余了。

Function design®是一种独立于工具的方法。本研讨不会使用或评估工具来评价半自动或全自动的API文档生成方式。

 

!!!带上纸笔或者笔记本电脑,和演讲嘉宾一起互动,边学边练习吧。