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:
Category: Software
What capabilities do Technical Authors want in an authoring tool?
We were contacted last week by a SaaS developer who wanted to know if their solution might be of interest to companies needing to write and host their product’s user manual or online Help content. So what capabilities do Technical Authors look for in an authoring tool? There were a few features that sprung to mind: Multi-channel publishing (for… Read more »
Not so cool tools for Technical Authors – speech recognition software
Our method for creating online courses involves making an audio recording of the presenter, transcribing it, editing the script and then recording the final, video presentation. We’ve tried using speech recognition software to create the transcribed script, and it has been a deeply frustrating experience. While speech recognition is proving successful for searching and issuing… Read more »
Draftback – could it reveal how Technical Authors actually write?
James Somers is releasing an add-on for Google Docs, Draftback, that enables you to play back and analyse the creation of any Google Doc you have permission to edit. It means you can see how a writer created the document, the sections they spent time rewriting and rearranging, the elements that were pasted into the document from… Read more »
Your policy and procedures manual as software
Jared Spool tweeted this morning: PLEASE, PLEASE! Tell me that Apple is going to release Hypercard for the iPad! — Jared Spool (@jmspool) September 9, 2014 HyperCard was a hypertext program that came with Apple Macintosh in the 1980s. It allowed you to create “stacks” of online cards, which organsiations used to create some of the first… Read more »