tcworld China 2017

... the premier gathering event for all decision-makers and specialists in the field of technical communication in China!

25 national and international expert speakers

... will share their experiences and best practices with solutions for China-specific challenges.

150 CIOs, R&D managers, TC managers...

... TD engineers, technical writers, development leaders, information designers, content architects, ... are expected.

The conference venue on May 8-9, 2017

... is InterContinental Shanghai Pudong!

 

The Funktionsdesign® Method for Developer Documentation

What it is: the demands on developer documentation are increasing. In addition to the complete reference, explanatory and easy-to-understand texts are also desired.

Just how do you achieve this? Parameters better in a table or list? Code Snippets rather bold or monospace font? Where starts a new chapter and where a new paragraph? What information comes on the homepage and which explains the tutorial?

In this half-day workshop, methods are used to "design" documentation. The goal is to create a comprehensible and compact developer documentation for the API of an app in the team. From use cases, first ideas and mindmaps, a text is formed layer by layer. Funktionsdesign® helps to write the introduction, concepts, functions and tutorials meaningfully. If time remains, sample documentation brought along can be unpacked layer by layer inversely and checked for form and function. Function design ® is a method independent of tools. The workshop will not use or evaluate tools for the semi-automatic or fully automatic generation of documentation for an API.

 

For the active cooperation, a notebook with a text editor or simply a piece of paper and pencil.