One of the factors that influences the development of new training courses is, naturally, the potential level of interest in a particular course. If you have any comments on what you’d like to see in a course on planning and writing API documentation, please email us with your thoughts.
Cherryleaf Blog
Reflections on last week’s mini-conference on documenting APIs
Last Friday, I attended and presented at the Write The Docs mini-conference on documenting APIs, held at the Government Digital Services (GDS) building in Holborn. My presentation was called “What makes Technical Communicators uneasy about API documentation, and what can we do about it?”, and there were a number of questions and comments regarding some of… Read more »
The return of Clippy?
Are we seeing the the spiritual child of Clippy emerge? Truth Labs’s Stelios Constantinides has written an article on his experiments with conversational UIs. Conversational user interfaces (CUIs) are a spoken or written way of interacting with a device. CUIs aren’t completely new, but they’re becoming smarter, more natural, and — therefore — more useful. Here’s where CUIs come in:… Read more »
One to watch – Swagger2markup
Swagger2Markup promises to simplify the generation of REST API documentation by combining auto-generated API documentation produced by Swagger with manually written content. To include the programmatically generated snippets in your documentation, you’d use Asciidoc’s Include macro. The output would look like this:
API documentation design patterns
One of the current developments in technical communication is the development of a common way to present API documentation. At present, there are a number of different design patterns that organisations are using, but, as with many things, there seems to be a desire to establish a de facto standard. One part of this has… Read more »