Blog

Working in self-organizing teams. Or: how we get rid of management

Today's world is VUCA : volatile, uncertain, complex, and ambiguous. Companies are facing complex challenges such as Industry 4.0 and the Internet of Things. Those who do not respond fast, may be driven out of the market. more ...

Office Pets. Part II: Blacky and Felix

This is the second (and last) part of our blog series about office pets. This time, we present Blacky and Felix, two brothers. They are six years old, curious, and always hungry. more ...

Check if or check that? Or: Have you tried turning if off and on again?

How often do we read or write that we should check something? Example: "Check if the computer is connected to power." Clear message, no misunderstanding. But what if it says: "Check that the computer is connected to power." more ...

Ten questions for Ines Lasch, intern at parson

Ines Lasch just finished her vocational training as a technical writer and is doing an eight-week internship at parson. We asked her ten questions. more ...

Vocational Training for Technical Communicators. How Does it Work?

Anja Schiel, trainee, and Ulrike Parson, CEO of parson AG, offer their insights into the vocational training for technical communicators. more ...

How to write API documentation

When APIs are developed, documentation often comes last. It is squeezed in when the deadline is near or in jeopardy. And quite often, the software developer, already working overtime, fixing bugs, making last-minute changes, is asked to write it.

There are developers who can both: code and write. But most likely the developer is much better at coding than at writing. And honestly – many developers do not enjoy writing documentation.

I have found little information on the Internet on how to write good API documentation. When I finally came across this excellent MSDN article by Peter Gruenbaum, I was delighted.

We also started to write down our own thoughts and concepts. See Ulrike Parson's article Documentation for Software Engineers.

  • linkedin
  • xing