Embed Notice

i will never stop stressing the importance of a “culture of documentation”, where you make it as seamless as possible to write and consume documentation, provide top-tier examples of excellent documentation, and build the incentives for people to write and show off their own documentation in a virtuous cycle where everybody benefits

rust has this with `cargo doc` and docs.rs. swift *almost* has this with Swift-DocC and the Swift Package Index, but generating documentation at-desk still requires modifying your package spec to enable the CLI tooling.

plus, while “official” libraries like the standard library and the Apple SDKs have professional documentation, we still need to extend this quality to foundational libraries like Swift NIO and other server-side packages. (i haven’t used NIO personally, but we just talked about it in the Documentation Workgroup meeting.)

if everyone has trivial access to high-quality documentation and an easy means to host their own, everybody benefits.