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.

Blog

tcworld 2018: What's New with iiRDS?

iiRDS was one of the central topics at the tcworld conference 2018: at the new iiRDS Café, in lectures, showcases, and tutorials. There was also a discussion on Twitter, among other things about the name, which is so difficult to pronounce. more ...

tcworld 2018 part 3: Creative online videos for technical documentation

Clear the stage! At the beginning of his workshop "Creating thrilling online videos", Stephan Schneider showed two pictures. more ...

tcworld 2018 part 2: Virtual and actual highlights

The sun is shining brightly as I arrive for my first tekom. Inside, the conference is already in full swing. Two days of presentations, workshops, fair impressions and conversations await. more ...

tcworld 2018 part 1: Legal Requirements vs Readability

At this year's tcworld conference, there were a lot of discussions about standards and regulations for technical documentation. Experts such as Jens-Uwe Heuer-James and Torsten Gruchmann came together for a panel discussion where the following was repeatedly said: "We need an IEC 82079-1!" more ...

Working in self-organizing teams. Or: how we get rid of management

Today's world is VUCA : volatile, uncertain, complex, and ambiguous. Companies are facing complex challenges such as Industry 4.0 and the Internet of Things. Those who do not respond fast, may be driven out of the market. more ...
  • linkedin
  • xing