Announcing The Swift.org Redesign Project

First, thank you for your feedback.

I think there are two separate issues you describe:

  1. Where the documentation is hosted / located
  2. The quality of the documentation itself

The first issue is part of what the Swift Information Architecture Project, which is running in parallel to the redesign project, will be working to address.

The second issue is important also. IMO, for general usage of an API, developers shouldn't need to inspect source code to figure out how the API works. But it is outside the scope of the information architecture project - the goal of the project is that when that documentation is written it has a well-defined place where it will appear.

I encourage you to read through the information architecture project brief and potentially become a participant in the project. Although the project is just ramping up, there will almost certainly be a working group focused on documentation.

4 Likes