Hacker News new | past | comments | ask | show | jobs | submit login

I'm sure it hasn't been perfect either, but "I write better developer documentation than the large software corporation Apple" wasn't the focus of his complaint.

Specifically, he claims: that large portions of the Swift user interface API are entirely undocumented; that he was unable understand the full capabilities and limitations of the package manager through reference to its documentation; that he finds himself frequently searching video transcripts to find information unavailable in the documentation.

I think that, if these claims are true, it does not reflect a good state of affairs, and that the extra work imposed on the individual developer is worth complaining about.

I don't think that he is calling out the work of the technical writers in any unsociable or shameful fashion in the text of his blog post. I agree that 'garbage' is not a good metaphor for "woefully inadequate," as it implies that the existing documentation would be better disposed of than referred to. However, I think that when dealing with a large software corporation that has teams dedicated to writing and maintaining technical documentation, it is not especially cruel or unfair to use hyperbolic language in calling extraordinary lapses to public attention.




This is a fair criticism; I'm updating the title of the post and adding a note about the change in title accordingly.


SwiftUI is not "large portions of the Swift user interface API". SwiftUI is a brand new API, still in beta, released during the last month.

The actual, in-production APIs are documented.




Guidelines | FAQ | Support | API | Security | Lists | Bookmarklet | Legal | Apply to YC | Contact

Search: