A Process for Technical Documentation

When you've been a technical author for many years, the process of creating technical communication becomes second-nature. So when a client asked me to draw up a technical communication process, I had to think carefully about each step of the process. Of course, it can vary depending on the organisation, but on the whole, the process I work to is pretty much: Get brief > plan content >interview SMEs>write content >get content reviewed >rewrite content >get content reviewed >get content approved and signed off >put technical documentation into document management system.To make it easier to remember, I decided to hire a designer to create an infographic showing the process for technical documentation, which you will find below. Hopefully the infographic will be of some use to you.

A Process for Technical Documentation - An Infographic

The following infographic shows the typical process I follow as a technical author. It has applied when working on software and hardware, although it does take a 'best case scenario' approach. In reality, there are often changes to the brief in between later stages.

Technical Documentation Process - Infographic

Technical Documentation Process - Infographic

Looking to Hire a Technical Documentation Specialist?

With over 16 years' experience as a technical writer, a degree in Technical Communication, and expertise in a wide range of technical writing tools, I could be just the man for your documentation project. I am available to hire in the Midlands or possibly further afield if some home-working is a possibility. Prices from £30 per hour freelance. For more details, please get in touch.

Craig Wright technical author

Craig Wright is an experienced technical writer based in Chesterfield, UK.  He hates writing about himself in the third person, so I shall stop now.

Always interested in new content writing opportunities. Remote working preferred.

Contact Craig

Straygoat Writing Services Ltd

26 Wheatlands Road

Wingerworth

Chesterfield

Derbyshire

Registration Number: 08029184.

© Straygoat Writing Services Ltd.

By clicking “Accept All Cookies”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Cookie Policy for more information.