Technical writing samples

Help guides, references, manuals, release notes, walk-throughs and presentations.

Help guides

Two-step authentication

February 2018 · The University of Warwick
Audience: University staff, postgraduate research students and IT Help Desk staff.

External Users

October 2017 · The University of Warwick
Audience: departmental administrators and IT staff who use the External Users system to manage IT accounts for non-University members.

Reference

ID7 website template guidelines

April 2015 · The University of Warwick
Audience: departmental web editors, IT staff and external design agencies.

Tabula Manual

2014-present · The University of Warwick
Audience: administrators, markers, tutors, students and IT support colleagues.

Tabula is the Warwick Web Team's busiest web application regarding support requirements. It's used mainly by departmental administrators to:

  • manage coursework assignments, including routing students' work through various workflows for marking and moderation
  • schedule small group teaching events such as tutorials and lab classes, and allocate students and tutors to those events
  • monitor students' attendance

I wrote the Tabula Manual in 2014 and have maintained it since, keeping it up to date with weekly app version releases. The Manual is restricted to University members behind a firewall so I can't link to it, though I've written about how I approach structuring and writing the Manual.

Release notes

Tabula

March 2018 · The University of Warwick
Audience: departmental administrators; IT colleagues who want to know which JIRA issues are resolved in a version release.

SiteBuilder

May 2018 · The University of Warwick
Audience: departmental web editors who use SiteBuilder, the University's content management system; IT colleagues who want to know which JIRA issues are resolved in a version release.

Walk-throughs

Refactoring a Hugo theme's stylesheet

June 2018 · Personal project

Recording guitar with two amps

October 2015 · Personal project

Visualisation of listening habits using last.fm API and Google Spreadsheets

January 2011 · Personal project

Presentations

Start sharing public sector data online

July 2010 · West Midlands Regional Observatory

This is an internal presentation I gave to social and economic researchers. My aim was to advocate for the open data movement's core principles and to summarise policy developments during 2009-2010 into practical steps the researchers could take. I tailored the presentation to those working with datasets as part of their research.

View presentation on Scribd · Download .pdf