Samples of technical writing work

I’d love to be able to share some of my larger projects with you, but unfortunately, they are not in the public domain. However, I can share a couple of samples as working examples, and there are screenshots of other projects. 

Make sure you check out my testimonials and case studies too.

4Energy Flare HTML5 sample

This is a sample I created using content from a much larger documentation suite. The original content was created in Atlassian Confluence, but I have repurposed it as Flare HTML5 online help.

To see the sample, click the image.

TimeCode Flare HTML5 sample

This is a sample of a user guide for a time synchronisation device (made by Timecode Systems).

To see the sample, click the image.

Financial software online help

This online help was created in Paligo and the content was also used for PDF outputs. It explains how to use financial software.

Help articles for time sync device

This content was originally written in Flare and then converted into Zendesk articles. The Flare content was also used for PDF.

Healthcare processes online help

This project involved converting and rewriting existing content into a customised Flare output. The client is an out of hours health care provider to the NHS.

Free-air controller guide

This print manual was created in MS Word. It explains how to install an eController unit. This is a control device for managing fan speeds and alarms.

Thermal monitoring software wiki

This is documentation for SMARTset software, which is a monitoring and control system used for managing data centre temperatures.

STIM device user guide

This print manual was for a pelvic floor strengthening device, aimed at women. The time and budget were tight, hence the lack of visuals.

SCADA software online help

This project involved converting content from Adobe FrameMaker into MadCap Flare. I also had to write new content about Schneider Electric’s SCADA system.

Articles for Communicator

I have written articles which were published in the award-winning ISTC journal ‘Communicator’. The articles also appear as posts on my LinkedIn page.

API documentation

I was hired to create API documentation by a transport company. They needed examples in XML and JSON, so I used Paligo’s ‘stripe’ API layout. What’s great about this layout is that it lets users switch the code examples between different languages.

Thermal monitoring software
user guide

EkkoSense create data centre cooling solutions, and they hired me to create a video-game-style manual for their thermal monitoring software, EkkoSoft. I created the short booklet in Adobe InDesign and EkkoSoft loved it.