Category Archives: Technical Documentation

Technical Writing | Project Managers and Technical Writers

Can project managers and technical writers get along? I always make the point to Project Managers that Technical Writers are highly organised. They juggle numerous tasks and switch between them with ease. They also have great people skills working with coders, engineers, … Continue reading

Posted in Technical Documentation, Technical Writer, Technical Writing | Tagged | Leave a comment

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 passive voice, the grammatical subject expresses the theme or patient of the main verb – that is, … Continue reading

1 Shares
Posted in Documentation, Technical Documentation, Technical Writer, Technical Writing | Leave a comment

Technical Writing | Interviewing SMEs

Without Subject Matter Experts to impart their knowledge about their technologies writing that content will be a harder job. So, how does an experienced technical writer consider approaching and interviewing Subject matter experts? I base my advice on my personal experiences … Continue reading

2 Shares
Posted in Documentation, Process Documentation, Technical Documentation, Technical Writer, Technical Writing | Leave a comment

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 … Continue reading

5 Shares
Posted in Documentation, Technical Documentation, Technical Writer, Technical Writing | Tagged | Leave a comment

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 … Continue reading

Posted in Document management, Documentation, Technical Documentation, Technical Writer | Tagged , | 1 Comment

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 … Continue reading

Posted in Helpdesk Support, Technical Documentation, Technical Writer, Technical Writing | Tagged , | Leave a comment

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 … Continue reading

Posted in Documentation, Technical Documentation, Technical Writer, Technical Writing | Tagged , , | Leave a comment

Technical Writing | Hire a Technical Writer sooner, rather than later

As a Technical Writer with over Twenty Years experience, I have a question for Project Managers and Subject Matter Experts. Have you ever been involved in planning a project (PCI, GDPR, ISO27001, ITIL) where documentation is critical; if so, how … Continue reading

1 Shares
Posted in Documentation, Process Documentation, Technical Documentation | Tagged , , , | Leave a comment

Technical Writing | Why your business needs Technical documentation

Managers underestimate the purpose of technical documentation until they discover they have no relevant documentation. Listed below are 6 reasons why you need technical documentation Without technical documentation you have no historical record of any project ever completed within the company … Continue reading

Posted in Documentation, Process Documentation, Technical Documentation, Technical Writer, Technical Writing | Leave a comment

Documentation projects, before, during and after

Documentation Projects Many Project Managers and Subject Matter Experts fail to understand the challenges posed by documentation projects. To lead such a project, you need to know what is important and how you will achieve the goal. What preparations should … Continue reading

2 Shares
Posted in Document management, Documentation, Technical Documentation | Leave a comment