Blog

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 ...

Is DITA working for you? Results from the DITA Satisfaction Survey 2017

How satisfied are adopters with DITA? Technical communication professionals working at 250 companies around the world have taken part in the DITA Satisfaction Survey 2017 so far. The preliminary results have now been published. more ...

The Core of Intelligent Information - Metadata

The new tekom blog is all about intelligent information. The blog brings together experts from related fields to explore the various aspects of the design and development of intelligent technologies. more ...

The parson mug prize draw 3. Congratulations to the winners

What's the name of the building behind the parson mug, we asked at the beginning of June. A tricky question, but many answsered correctly. Three winners were drawn. Congratulations! more ...

Prize draw: The travelling parson mug #3

The parson mug collected bonus miles again! At first sight, you might not see where our adventurer travelled this time, but don’t worry. We’ll help you. 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