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

tcworld conference report, part 4: About a terminology workshop and error messages that don't scare us

In our last report about the tcworld conference 2019 we talk about an enlightening terminology workshop  and error messages that scare us. more ...

Is AI a chance or a threat for technical communicators?

The phrase artificial intelligence (AI) is a mystery. Everyone immediately associates something with it, but the ideas are rarely identical. more ...

Jumping in at the deep end. tcworld conference report part 2

I'm an old hand at the tcworld conference and shouldn't be too excited when giving a talk. But when Dieter Gust and I brought our crackpot idea to the stage, I started to feel queasy. What were we thinking? more ...

When three technical communicators go out to dinner. tcword conference report, part 1

When three technical communicators go out to eat at an Italian restaurant after an inspiring but exhausting day at the tcworld conference, the following can happen. more ...

The iiBot gives instructions

Imagine a chatbot that gives precise instructions - live, based on the use case, and tailored to the service technician's qualification. more ...
  • linkedin
  • xing