Speaker Deck

API docs in DITA & Markdown

by Roger Sheen

Published March 4, 2016 in Technology

This talk proposes a hybrid approach to API documentation that combines Markdown output generated by API docs tools like API Blueprint, RAML, or Swagger with more complex content authored in DITA and published via the DITA-OT Markdown plug-in for delivery via GitBook or other Markdown-based publishing systems.

Presented March 4, 2016 at the Write The Docs London mini-conference on Documenting APIs hosted by the UK’s Government Digital Service.