Following on from our post The Internet of Things – creating a user guide for a fridge door, we came across other ways to create e-ink digital user guides that could be attached to the door of meeting rooms, providing information on room bookings, using the equipment in the room etc.
Category: tools
The Internet of Things – creating a user guide for a fridge door
The Internet of Things (IoT) is, according to Wikipedia, the network of physical objects – devices, vehicles, buildings and other items – embedded with electronics, software, sensors, and network connectivity that enables these objects to collect and exchange data. The popular example is the concept of a smart fridge that could warn you when it… Read more »
Creating documentation in a Continuous Integration/Continuous Delivery environment
Creating user documentation and online Help in a Continuous Integration/Continuous Delivery environment can be challenging for technical communicators and developers.
Perfecting collaborative authoring for online Help
Yesterday, I wrote: “There are some activities that seem like they always could be improved. One is creating an authoring environment where professional technical communicators and other staff can work together.” Writing online Help is different from writing some other types of content, in that it involves topic-based authoring. Content is stored in modular, re-usable and flexible… 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: