1. Edition 2018
ISBN 978-3-944449-82-1 (Softcover)
PDF, 68 Pages, 1. Edition 2018
ISBN 978-3-944449-83-8 (E-Book PDF)
Standards and Guidelines for API Documentation
Publishing Company: tcworld GmbH
- Practical Guides
- API Documentation
70,00 € (for Members 45,00 €) Softcover, 68 Pages Status: Available
55,00 € (for Members 35,00 €) E-Book PDF, 68 Pages Delivery time: 2-3 working days Status: Available
97,50 € (for Members 62,50 €) Bundle Softcover & E-Book PDF
In the rapidly expanding API economy, software vendors are expanding their offerings of development platforms, tools and APIs. Professional API documentation is a key facilitating factor in the adoption of these offerings. 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, resulting in lower-quality documentation. On the other hand, professional technical writers don’t always have the special knowledge and skills required to handle these topics.
To address these gaps, a group of API documentation experts at SAP, led by Anne Tarnoruder, was formed in 2014 to produce a company-wide set of standards, guidelines and best practices. These Standards and Guidelines (S&G) aim to reach a higher level of quality and usability for the APIs published by the company, and thus increase customer satisfaction with and acceptance of APIs.