List-style API diff document should be released with iOS announcement

Originator:futuretap
Number:rdar://32923415 Date Originated:22-Juni-2017 04:16 PM
Status:Duplicate/32573203/Open Resolved:
Product:Documentation Product Version:iOS 11
Classification:Enhancement Reproducible:Always
 
Summary:
Immediately after today's WWDC keynote where iOS 11 was announced, a new set of documentation and information was released to developers about iOS 11.

Included in this set of documentation is information about API changes - i.e. modified, added, and deprecated APIs - which, currently, can only be viewed through the Apple Developer Documentation viewer, located here:
https://developer.apple.com/documentation?changes=latest_minor

Unfortunately, this viewer is a poor tool for broadly analyzing the large number of API changes that come with a major new release of the OS. Most importantly, the viewer requires users to drill down through the class hierarchy to discover changes. This is cumbersome and slow.

In the past, a 'list-style' API diff document was published. This is an example of this:
https://developer.apple.com/library/content/releasenotes/General/iOS10APIDiffs/

This list-style format is a far better format for quickly identifying API changes. All changes are summarised on a single page, without requiring the user to manually drill down through a class hierarchy and separate differences from unchanged APIs.

It is requested that this style of documentation is added to the standard set of documentation released at announcement-time.

Steps to Reproduce:
Assess API diffs using https://developer.apple.com/documentation?changes=latest_minor

Expected Results:
An easy, convenient way to assess all API changes

Actual Results:
A hard, cumbersome way to assess all API changes

Version:
iOS 11

Notes:

Comments


Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!