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


Blog

iiRDS - A Standard for Intelligent Content

The ongoing digitization requires us to think about more sophisticated publishing and delivery technologies for our content. Today, we want to deliver an exact piece of information for a particular use case or situation. That’s why we assign metadata to content and make information intelligent. So far so good. more ...

parson at tcworld conference 2019

Meet us at the tcworld conference in Stuttgart, Germany, in November 2019! more ...

A Shoe is a Shoe is a Shoe. But a Knot is not Always a Knot.

I'm clumsy and not just a bit. Ask my colleagues, they will confirm it. So it is not surprising that since my childhood I have not been able to tie my shoes properly. more ...

Running in Escheburg

Three parson runners participated in a community running contest in Escheburg, near Hamburg. more ...

We have moved offices

Finally! We have moved into a new and spacious office building. The old one had become so small that we almost stepped on each other's toes. Plus, it sometimes became so noisy that our ears were ringing after work. more ...
  • linkedin
  • xing