Technical Writing
Do you need an induction manual for new staff?
Do you need to make your Standard Operating Procedures accessible to readers with limited literacy or English as second language?
Do you need to check if your operations manual makes the use of your equipment safe for the lay person?
Do you need instruction manuals?
The term ‘technical writing’ is mainly used for specialised content, e.g. for software development, engineering and other industries that require in-depth and detailed knowledge. People who work within these industries study for years, they need to learn and understand complex information to be successful in their careers.
People who use the products developed by these industries don’t have the same knowledge. They might not need it either – I don’t need to know how an engine works to drive a car. However, a mechanic who explains why certain maintenance tasks are important to maximise the benefit I get from my car is more likely to get my business than a mechanic who can’t explain why I should change my cambelt.
A technical writer who works across a variety of industries comes to specialist content with 'a set of fresh eyes’ and a client's perspective, asking the questions the client needs answered to make a decision. Complex information is translated into plain language, a software's capabilities are translated into solutions for the client's problems.
The term technical writing applies to all texts that aim to translate knowledge from a specialised industry into plain English. Combining the technical writer's language skills with the specialist's subject knowledge results in texts that are accessible to and appropriate for the intended audience.
I work with specialists to ensure that documents
contain the complete, correct and concise information required
make the specialist topic accessible to all
are written in a language that non-specialists understand
explain health hazards to trainees working in dangerous environments, e.g. as a stevedore on a port
Standard Operation Procedures are translated into plain English that is accessible to second-language speakers and people with limited literacy
contain images and drawings to illustrate what's difficult to put into words
describe how cloud-based technology can assist business owners of all industries in their daily management.
“Hella has done a great job getting under the hood of Ag Hub in order to understand the overall solution namely the devices used on farm and how they feed data into the various online modules to provide the farmer information and insight to make the right decision.
Hella is very passionate about what she does, no stone is left unturned. A pleasure to work with.”
Get in touch to find out how I can help.
"Hella was employed as a contract documentation expert. She has produced dozens of training and induction manuals particularly in the Stevedoring, Logistics and Marine spaces. Hella is very sharp at analysing business practice and converting that to plain English. Her results are fantastic and her analysis of process and subsequent documentation has really helped our staff learn the right skills in the right manner."