Technical Writing

Technical writing is typically aimed at audiences to understand how to use a product, therefore every piece of content targets a specific group or niche of people. My main focus is on End-user documentation that provides instructions for the end-user. The instructions are typically laid out in such a way that it is easy to understand by non-technical users. The type of content that I focus on is as follows:

  • User Guides – This is an instructional manual that directs the user on how to use and interact with the software. It details a step-by-step approach how to use the software.
  • Project documentation – These are documents used by project managers in project control and execution. It documents the stages involved in project management such as initiation, planning, execution, control, and conclusion.
  • How-To guides – This is an informative technical document that is aimed at teaching users a particular subject or process.
  • Standard Operating Procedures – These are typically internal documents that aid employees in an organization to carry out their duties.
  • Release Notes – These type of content encompasses every fix, upgrade, and enhancement made to an application. It is typically released after product development.
  • Blogs, Newletters – These are informative content that is aimed at teaching or informing clients and/or users of a particular subject, achievement or process.
  • Online Training content – These are instructional guides used for online training portals

If you can’t explain it to a six year old, you don’t understand it yourself – Albert Einstein

Below is some examples of work I did for clients.

Online Software User Guide

I have expertly documented an entire Warehouse Management System (WMS) software suite, creating an intuitive and accessible online software user guide. This guide is meticulously organized into various software modules, allowing end users to effortlessly find and utilize the content they need. My work ensures that users can navigate the WMS user guide with ease, enhancing their overall experience and productivity. This project showcases my ability to deliver clear, structured, and user-friendly technical documentation, tailored to meet the needs of diverse audience.

Blog articles and Newsletters creation

I created multiple printed newsletters, which were also published online and distributed via mailers. Additionally, I have authored a diverse collection of blog articles focusing on Warehouse Management Systems (WMS) and its software suite modules. These articles effectively explain complex concepts to the client base, enhancing their understanding and engagement. My work showcases my ability to produce clear, informative, and engaging content accross various formats, tailored to meet the needs of different audiences.

View all blog articles – DATASCOPE WMS Blogs

View Newsletters – DATASCOPE WMS Newsletters

Comprehensive Technical Writing for Software F1 Help screens

I have created and written the entire F1 Help content for a WMS software suite, covering each module and screen within the software. This F1 help content is seamlessly integrated into the software, allowing users to access it directly. The F1 Help screens are fully searchable and include links to related topics, ensuring users can easily find the information they need. It demonstrates my ability to produce detailed, user-friendly documentation that enhances user experience and supports efficient software use.

Mailers

Design and create of weekly mailers.

Wiki

This is a mock-up for a wiki page design done for an Infrastructure Design document. I’ve broken the document down into smaller chunks to make it easier for the Engineers to find the specific area of info they require.

The original document is done in MS Word and quite lengthy and I redeveloped it using the Jira Confluence Wiki page. The company uses Jira for their Agile (Scrum) approach as well, so it fits in nicely with their project management methodology

Functional Specifications

This Functional Specification was written for a short-term insurance company. The objective of the specification was to communicate the requirement around monitoring the SLA for each Claim Handler.

This Functional Specification was written for a short-term insurance company. The objective of the specification was to communicate the entire solution from the creation of tickets, assignment of tickets and process flow until a ticket is closed.

Software Manual

This is an example of one of the pages from a Software Manual done for the OpenSource community (LibreOffice). I was responsible for proofreading and editing – specifically focusing on comparing content with the latest version of the software to ensure correctness.

User Guides

quick-guide-alertsDownload

This Quick Guide (which is only an example of one – multiple Quick Guides were created as part of this project) was developed for one of South Africa’s major banks – these were used to facilitate and assist with user adoption and training for the rollout of their SharePoint platform, which was used as their intranet and knowledge centre.

Deployment Plan

This is an example of an Infrastructure Deployment Plan of installation steps to be followed to be submitted to a Change Management Team for approval. I was responsible for creating (with the assistance of an Engineer), proofreading and comparing technical detail (server names, Firewall flows, etc) with related documents.

Please view more writing examples under my Visual Design page.