{"id":30631,"date":"2020-11-10T14:36:37","date_gmt":"2020-11-10T19:36:37","guid":{"rendered":"https:\/\/mjtsai.com\/blog\/?p=30631"},"modified":"2020-11-11T20:02:59","modified_gmt":"2020-11-12T01:02:59","slug":"on-apples-piss-poor-documentation","status":"publish","type":"post","link":"https:\/\/mjtsai.com\/blog\/2020\/11\/10\/on-apples-piss-poor-documentation\/","title":{"rendered":"On Apple&rsquo;s Piss-Poor Documentation"},"content":{"rendered":"<p><a href=\"https:\/\/www.caseyliss.com\/2020\/11\/10\/on-apples-pisspoor-documentation\">Casey Liss<\/a> (<a href=\"https:\/\/twitter.com\/caseyliss\/status\/1326177048172359682\">tweet<\/a>, <a href=\"https:\/\/news.ycombinator.com\/item?id=25046691\">Hacker News<\/a>, <a href=\"https:\/\/apple.slashdot.org\/story\/20\/11\/10\/165209\/on-apples-piss-poor-documentation\">Slashdot<\/a>):<\/p>\n<blockquote cite=\"https:\/\/www.caseyliss.com\/2020\/11\/10\/on-apples-pisspoor-documentation\">\n<p>For the last year or two, I&rsquo;ve come to realize that the number one thing that makes it harder for me to do my job is documentation. Or, more specifically, the utter dearth of documentation that Apple provides for its platforms.<\/p>\n<p>[&#8230;]<\/p>\n<p>The march of progress doesn&rsquo;t help, either. As my friend <a href=\"http:\/\/swinden.com\">Adam Swinden<\/a>\n<a href=\"https:\/\/twitter.com\/AdamSwinden\/status\/1326122584669376513\">pointed out to me on Twitter<\/a>, as old APIs get deprecated, often times\nthe new ones can&rsquo;t be bothered to include documentation. Check out the difference\nbetween <a href=\"https:\/\/developer.apple.com\/documentation\/photokit\/phphotolibrary\/1620736-requestauthorization\">this API<\/a> and <a href=\"https:\/\/developer.apple.com\/documentation\/photokit\/phphotolibrary\/3616053-requestauthorization\">the one that replaces it<\/a>.<\/p>\n<\/blockquote>\n\n<p>The number one thing for me is APIs that simply don&rsquo;t work, but documentation is probably number two.<\/p>\n\n<p>Previously:<\/p>\n<ul>\n<li><a href=\"https:\/\/mjtsai.com\/blog\/2019\/05\/20\/the-state-of-apples-developer-documentation\/\">The State of Apple&rsquo;s Developer Documentation<\/a><\/li>\n<\/ul>","protected":false},"excerpt":{"rendered":"<p>Casey Liss (tweet, Hacker News, Slashdot): For the last year or two, I&rsquo;ve come to realize that the number one thing that makes it harder for me to do my job is documentation. Or, more specifically, the utter dearth of documentation that Apple provides for its platforms. [&#8230;] The march of progress doesn&rsquo;t help, either. [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"apple_news_api_created_at":"2020-11-10T19:36:40Z","apple_news_api_id":"b5aa4b6e-349c-40bb-81e5-9234f92ae28e","apple_news_api_modified_at":"2020-11-12T01:03:02Z","apple_news_api_revision":"AAAAAAAAAAAAAAAAAAAAAQ==","apple_news_api_share_url":"https:\/\/apple.news\/AtapLbjScQLuB5ZI0-Srijg","apple_news_coverimage":0,"apple_news_coverimage_caption":"","apple_news_is_hidden":false,"apple_news_is_paid":false,"apple_news_is_preview":false,"apple_news_is_sponsored":false,"apple_news_maturity_rating":"","apple_news_metadata":"\"\"","apple_news_pullquote":"","apple_news_pullquote_position":"","apple_news_slug":"","apple_news_sections":"\"\"","apple_news_suppress_video_url":false,"apple_news_use_image_component":false,"footnotes":""},"categories":[4],"tags":[164,31,1837,30,1891,71,1812],"class_list":["post-30631","post","type-post","status-publish","format-standard","hentry","category-programming-category","tag-documentation","tag-ios","tag-ios-14","tag-mac","tag-macos-11-0","tag-programming","tag-swiftui"],"apple_news_notices":[],"_links":{"self":[{"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/posts\/30631","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/comments?post=30631"}],"version-history":[{"count":3,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/posts\/30631\/revisions"}],"predecessor-version":[{"id":30659,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/posts\/30631\/revisions\/30659"}],"wp:attachment":[{"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/media?parent=30631"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/categories?post=30631"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mjtsai.com\/blog\/wp-json\/wp\/v2\/tags?post=30631"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}