The parson mug prize draw #6

Travelling is fun but can be exhausting. That‘s why the parson mug decided to spend a few days on the beach. more ...

A year in London. I am not just missing my sock

May I present Parsons Green in London? I think it's a perfect name for a London parson branch. That branch is not planned yet, but a bit of parson is actually in London at the moment. Me. more ...

Recommend+To? A Clear Recommendation

In technical documentation, we avoid recommendations. They rarely help the reader: The producer recommends ultra-light power cells. Why? What happens if I use others? more ...

iiRDS – How a Novice Sees the Information Delivery Standard

Lately, the newly developed tekom standard iiRDS has gained quite some attention. The next exciting step will be the release of version 1.0, which will be released soon. Requesting and delivering intelligent information as a standardized approach between individual enterprises is a pioneering step in the Internet of Things – but let’s rewind a little. more ...

Pets at the office. Part I: Molly

The atmosphere at our office is always good, but when Molly is there, it gets even better. Molly is good for us. 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