Month: January 2018

Technical Writing | General Data Protection Regulations

GDPR On the 25th May 2018, the new General Data Protection Regulations (GDPR) came into force. Companies outside the EU If your Company actively trades within the EU and stores, processes or shares EU citizens’ data, then GDPR does apply to you. Compliance and documentation One of the primary...

Technical Writing | Project Managers and Technical Writers

I always tell the Project Manager that being organised is a technical authoring skill. They juggle many tasks and switch between them with ease. They also have great people skills working with coders, engineers, and technicians of various shades. In the meantime, they manage a ream of documentation while...

Technical Writing | Passive vs Active Sentences

What is a passive sentence? A Passive sentence is a grammatical voice prevalent in many of the world’s languages. In a clause with a passive voice, the grammatical subject expresses the theme or patient of the main verb – that is, the person or thing that undergoes the action...

Technical Writing | Interviewing SMEs

Subject Matter Experts (SMEs) are essential to enable you the technical author to write that document. Without their input you will struggle. So, how does an experienced technical writer consider approaching and interviewing SME? I base my advice on my personal experiences of talking to and working with SMEs. You...

Technical Writing | Professional vs Amateur, its a matter of choice

A LinkedIn connection shared a poster, which read: Professional vs Amateur; If you think it’s expensive to hire a professional, wait until you hire an amateur. In 2004 I had two interviews; one in Watford and Cambridge. Both were software companies looking for a Technical Writer. Neither interview went to plan...

Technical Writing | Sourcing a technical writer

When sourcing a technical author, ensure their experience matches your requirements. You need to source one who has the right knowledge, background and expertise. At the interview, they should talk through that experience; if not keep searching until you do. Productive years as a Technical Writer An experienced Technical writer can...

Technical Writing | The risks of poor document management

The risks of poor document management stem from managing multiple types of documents in different formats, workflows and updates. If the documents, which are in constant use have no defined structure it will lead to an uncontrolled and unmanaged repository. This haphazard approach to managing the document Lifecycle impedes employee productivity. The...

Technical Writing | Disaster Recovery Plan

Document the Disaster Recovery Plan Remember, to be effective you must be prepared to document the plan. Without the documentation you risk the possibility of NOT recovering from a disaster, therefore placing the entire company at risk. If you have no existing documentation that describes the functions of the...

Technical Writing | Technical documentation vs Helpdesk

Technical Documentation vs Helpdesk – Despite the reluctance to invest in technical documentation, many managers bypass a proven way to cut back on calls to the Helpdesk. No doubt many helpdesks provide an excellent service and manage the demands of the users. The problem with most technical documentation including...

Technical Writing | What is technical writing and why you need it

What is Technical Writing? Technical writing is a skill and should you hear a Project Manager or Subject Matter Expert say: ‘anyone can write so “why do you need a Technical Writer?” continue reading. Technical Writing like many jobs has many facets. The fact you see Writer in the...