Notice: Function _load_textdomain_just_in_time was called incorrectly. Translation loading for the health-check domain was triggered too early. This is usually an indicator for some code in the plugin or theme running too early. Translations should be loaded at the init action or later. Please see Debugging in WordPress for more information. (This message was added in version 6.7.0.) in /home/sites/cherryleaf.com/public_html/wp-includes/functions.php on line 6114

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893

Warning: Cannot modify header information - headers already sent by (output started at /home/sites/cherryleaf.com/public_html/wp-includes/functions.php:6114) in /home/sites/cherryleaf.com/public_html/wp-includes/rest-api/class-wp-rest-server.php on line 1893
{"id":16150,"date":"2021-11-30T10:56:31","date_gmt":"2021-11-30T10:56:31","guid":{"rendered":"https:\/\/www.cherryleaf.com\/?p=16150"},"modified":"2021-11-30T10:56:31","modified_gmt":"2021-11-30T10:56:31","slug":"eight-typical-use-cases-for-creating-or-updating-api-documentation","status":"publish","type":"post","link":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/","title":{"rendered":"Eight typical Use Cases for creating or updating API documentation"},"content":{"rendered":"

Here are some of the common reasons why companies contact us about API documentation:<\/p>\n

    \n
  1. You’ve been providing APIs to your largest customers, together with a lot of onboarding and technical support. You want to have more (smaller-sized) companies use the APIs, but you’re worried about the strain that will place on your Support team.<\/li>\n
  2. You’re releasing a new version of your API. The current documentation needs updating, but you just don’t have the time (or the technical communication skills) to do it.<\/li>\n
  3. You’ve released your API, but its poor documentation means not enough developers are using it, you’re getting too many Support calls, or it’s seen as worse than your competition’s products.<\/li>\n
  4. Your product offerings and APIs are going to get a lot more complex. You know you’ll need great content to explain what the APIs do, how to get started, and how to use them effectively.<\/li>\n
  5. You’re launching your first API, and you know you’ll need to provide a great developer onboarding experience for you to succeed.<\/li>\n
  6. Your developer portal\/developer experience is a mess. There’s a lot of content, but it’s spread over explanations on Jira, readme files, files in a shared folder on Google Drive, PDFs originally developed for a single customer, web pages, wikis, video walkthroughs etc.<\/li>\n
  7. Your developers are too close to the APIs and products to explain it fully in a way that a new user would understand.<\/li>\n
  8. You’re getting battered by the competition, and one of the main reasons for this is that their developer documentation is so much better than yours.<\/li>\n<\/ol>\n

    Are there any other Use Cases?<\/p>\n","protected":false},"excerpt":{"rendered":"

    Here are some of the common reasons why companies contact us about API documentation: You’ve been providing APIs to your largest customers, together with a lot of onboarding and technical support. You want to have more (smaller-sized) companies use the APIs, but you’re worried about the strain that will place on your Support team. You’re… Read more »<\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[662],"tags":[649,785,276],"class_list":["post-16150","post","type-post","status-publish","format-standard","hentry","category-api","tag-apis","tag-developer-portals","tag-documentation"],"acf":[],"yoast_head":"\nEight typical Use Cases for creating or updating API documentation - Cherryleaf<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Eight typical Use Cases for creating or updating API documentation - Cherryleaf\" \/>\n<meta property=\"og:description\" content=\"Here are some of the common reasons why companies contact us about API documentation: You’ve been providing APIs to your largest customers, together with a lot of onboarding and technical support. You want to have more (smaller-sized) companies use the APIs, but you’re worried about the strain that will place on your Support team. You’re... Read more »\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"Cherryleaf\" \/>\n<meta property=\"article:published_time\" content=\"2021-11-30T10:56:31+00:00\" \/>\n<meta name=\"author\" content=\"ellis\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@cherryleafltd\" \/>\n<meta name=\"twitter:site\" content=\"@cherryleafltd\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"ellis\" \/>\n\t<meta name=\"twitter:label2\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\"},\"author\":{\"name\":\"ellis\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318\"},\"headline\":\"Eight typical Use Cases for creating or updating API documentation\",\"datePublished\":\"2021-11-30T10:56:31+00:00\",\"dateModified\":\"2021-11-30T10:56:31+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\"},\"wordCount\":289,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\"},\"keywords\":[\"APIs\",\"developer portals\",\"documentation\"],\"articleSection\":[\"API\"],\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\",\"url\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\",\"name\":\"Eight typical Use Cases for creating or updating API documentation - Cherryleaf\",\"isPartOf\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#website\"},\"datePublished\":\"2021-11-30T10:56:31+00:00\",\"dateModified\":\"2021-11-30T10:56:31+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.cherryleaf.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Eight typical Use Cases for creating or updating API documentation\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.cherryleaf.com\/#website\",\"url\":\"https:\/\/www.cherryleaf.com\/\",\"name\":\"Cherryleaf\",\"description\":\"Clear instructions your users will love. Tel: +44 (0)207 100 4513\",\"publisher\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.cherryleaf.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.cherryleaf.com\/#organization\",\"name\":\"Cherryleaf\",\"url\":\"https:\/\/www.cherryleaf.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png\",\"contentUrl\":\"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png\",\"width\":435,\"height\":121,\"caption\":\"Cherryleaf\"},\"image\":{\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/cherryleafltd\",\"https:\/\/www.youtube.com\/channel\/UCQQmJCmDrCqEAmBhinq0CIQ\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318\",\"name\":\"ellis\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/www.cherryleaf.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg\",\"caption\":\"ellis\"},\"sameAs\":[\"https:\/\/www.cherryleaf.com\"],\"url\":\"https:\/\/www.cherryleaf.com\/author\/ellis\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Eight typical Use Cases for creating or updating API documentation - Cherryleaf","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/","og_locale":"en_GB","og_type":"article","og_title":"Eight typical Use Cases for creating or updating API documentation - Cherryleaf","og_description":"Here are some of the common reasons why companies contact us about API documentation: You’ve been providing APIs to your largest customers, together with a lot of onboarding and technical support. You want to have more (smaller-sized) companies use the APIs, but you’re worried about the strain that will place on your Support team. You’re... Read more »","og_url":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/","og_site_name":"Cherryleaf","article_published_time":"2021-11-30T10:56:31+00:00","author":"ellis","twitter_card":"summary_large_image","twitter_creator":"@cherryleafltd","twitter_site":"@cherryleafltd","twitter_misc":{"Written by":"ellis","Estimated reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#article","isPartOf":{"@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/"},"author":{"name":"ellis","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318"},"headline":"Eight typical Use Cases for creating or updating API documentation","datePublished":"2021-11-30T10:56:31+00:00","dateModified":"2021-11-30T10:56:31+00:00","mainEntityOfPage":{"@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/"},"wordCount":289,"commentCount":0,"publisher":{"@id":"https:\/\/www.cherryleaf.com\/#organization"},"keywords":["APIs","developer portals","documentation"],"articleSection":["API"],"inLanguage":"en-GB","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/","url":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/","name":"Eight typical Use Cases for creating or updating API documentation - Cherryleaf","isPartOf":{"@id":"https:\/\/www.cherryleaf.com\/#website"},"datePublished":"2021-11-30T10:56:31+00:00","dateModified":"2021-11-30T10:56:31+00:00","breadcrumb":{"@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.cherryleaf.com\/2021\/11\/eight-typical-use-cases-for-creating-or-updating-api-documentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.cherryleaf.com\/"},{"@type":"ListItem","position":2,"name":"Eight typical Use Cases for creating or updating API documentation"}]},{"@type":"WebSite","@id":"https:\/\/www.cherryleaf.com\/#website","url":"https:\/\/www.cherryleaf.com\/","name":"Cherryleaf","description":"Clear instructions your users will love. Tel: +44 (0)207 100 4513","publisher":{"@id":"https:\/\/www.cherryleaf.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.cherryleaf.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/www.cherryleaf.com\/#organization","name":"Cherryleaf","url":"https:\/\/www.cherryleaf.com\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png","contentUrl":"https:\/\/www.cherryleaf.com\/wp-content\/uploads\/2018\/02\/cherryleaf-logo-snagit.png","width":435,"height":121,"caption":"Cherryleaf"},"image":{"@id":"https:\/\/www.cherryleaf.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/cherryleafltd","https:\/\/www.youtube.com\/channel\/UCQQmJCmDrCqEAmBhinq0CIQ"]},{"@type":"Person","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/3aac161439df53b58fcbc8bcd6bf5318","name":"ellis","image":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.cherryleaf.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/9c3553ccbc10f078e4acf1f1f8f3b6df?s=96&r=pg","caption":"ellis"},"sameAs":["https:\/\/www.cherryleaf.com"],"url":"https:\/\/www.cherryleaf.com\/author\/ellis\/"}]}},"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[],"_links":{"self":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts\/16150","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/comments?post=16150"}],"version-history":[{"count":0,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/posts\/16150\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/media?parent=16150"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/categories?post=16150"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.cherryleaf.com\/wp-json\/wp\/v2\/tags?post=16150"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}