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

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

tekom spring conference in Vienna

Ulrike Parson and Uta Lange share their impressions about the tekom spring conference in Vienna. more ...

How does Digitization Influence the Work of Technical Communicators?

Digitalization changes products, production processes, and the behavior of users. This results in new demands on the work of technical communicators. more ...

Technical Writer - A Career Path for Social Scientists

What can you do with a degree in social science? Fabian Klopfer has a master's degree in History and decided to become a technical writer. more ...
  • linkedin
  • xing