Blog

tekom impressions part 2: API documentation and the VUKA world

Daniela Herbold and Ulrike Parson write about better API documentation and solutions for innovative human resources management. more ...

Impressions from tcworld 2017

Part 1: Improvisation, fluff hunt, and videos for technical documentation. more ...

My first time at tekom

I got back from Stuttgart last night and it is safe to say that after three days of action-packed presentations, writing an article is not in the realm of possibilities right now as I try to connect one synapse with another. more ...

The parson mug prize draw #4. Congratulations to the winners

In which city was the parson mug photographed, we asked at the beginning of September. more ...

Flipped Classroom: Make Your Training More Efficient

Paying attention to students with different skill levels requires much time during onsite training. Students with more knowledge can get bored easily. Vice versa, students with less knowledge may get overwhelmed. 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.

Add comment


  • facebook
  • linkedin
  • xing