The market for application programming interfaces (API) is growing rapidly and software vendors are expanding their offerings of development platforms, tools and APIs. Professional API documentation plays a key role in the adoption of these offerings. The recently published book Standards and Guidelines for API Documentation by Anne Tarnoruder is a valuable source for both technical writers and developers producing API documentation.
Various companies and tool vendors define and maintain their own rules and best practices for documenting APIs, but so far there is no comprehensive, widely adopted industry standard in this area.
Furthermore, API documentation tends to fall between the cracks. It is often written by developers who don't have enough resources and professional writing skills, leading to lower quality in the documentation. Professional technical writers, on the other hand, do not always have the special knowledge and skills required for these topics.
To address these gaps, SAP formed a group of API documentation experts in 2014 to produce a company-wide set of standards, guidelines and best practices. The team was led by myself. These Standards and Guidelines (S&G) aim to reach a higher level of quality and usability in the APIs published by the company, and thus increase customer satisfaction and ...
Read more after login
tekom members can log in directly with their "My tekom" access data.
You are not yet a tekom member, but would like to read one or more articles in full? Then you have the opportunity to register on the internet portal of the technical journal 'tcworld' without obligation. Once you have registered, you can select any three specialist articles and view them in full for a period of two months. The selection will then be deleted and you can select three new articles for the next two months.
As a tekom member you benefit from the following advantages::
- Online access to all articles of the trade magazine 'tcworld magazine'
- Exclusive specialist articles from all areas of technical communication
- Regular new articles from over 300 authors
- The technical journal 'tcworld magazine' as a printed edition
- Reduced admission prices to tekom conferences
- Membership fees for tekom publications
- Access to 'my tekom', the web forum with job offers / job requests, appointments, expert advice, service provider file and much more
Promised: The trade magazine 'tcworld magazine' is the best we have. And we don't make the choice easy for ourselves. Every month, the editorial staff of the technical journal 'tcworld magazine' publishes the latest articles by renowned authors. This demanding selection is available exclusively to members of tekom (as usual, including the printed edition).
The trade magazine 'tcworld magazine' stands for intelligently prepared specialist articles, texts written to the point, informative content, surprising insights, international perspectives and communicates technical communication in an understandable, fast, clear and uncomplicated way - exclusively for you.