Apple promised to open source DocC. And now Swift team announces that documentation compiler becomes Swift open source project.

Developers now could contribute to DocC and also request new features via Swift JIRA.

Project depends on several related projects:

  • SymbolKit is a Swift package containing the specification and reference model for the Symbol Graph File Format.
  • Swift Markdown is a Swift package for parsing, building, editing, and analyzing Markdown documents. It includes support for the Block Directive elements that Swift-DocC’s tutorial files rely on.
  • Swift-DocC-Render is a web application that understands and renders Swift-DocC’s render JSON format.

Swift blog: Swift-DocC is Now Open Source

GitHub: Swift-DocC

Recommendations

Developer:

Use DocC for project documentation. Study syntax, common approaches, practices.

QA engineer:

Business as usual.

PM/DM:

Establish project practices to use DocC as standard for project documentation.

Leave a comment