Tom Johnson has written two interesting posts on his blog on the “Documentation as Code” concept: Will the docs-as-code approach scale? Review of Andrew Etter’s ebook on Modern Technical Writing Documentation as Code can be interpreted in a few ways. Tom describes it as being able to store the documentation with the code: From a… Read more »
Category: trends
Americanisms and Britishisms
There are user documentation projects where we are asked to write in American English instead of British English, and generally this is a pretty straightforward exercise for us. However, when I speak at conferences in the USA, delegates sometimes ask me afterwards what I meant by a particular expression. For example, I was recently asked… Read more »
Update: The Internet of Things – creating a digital user guide to attach to a door
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.
Microsoft launches its new documentation site, and it’s very good
Microsoft has announced the preview release of its documentation service, https://docs.microsoft.com, which currently provides content for its Enterprise Mobility products. “We interviewed and surveyed hundreds of developers and IT Pros and sifted through your website feedback over the years on UserVoice. It was clear we needed to make a change and create a modern web experience… Read more »
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 »