Category: Technical Documentation

Technical Writing | Project Managers and Technical Writers

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, and technicians of various shades. In the meantime, they manage a ream of documentation while…

Read More Read More

1 Shares
Technical Writing | Passive vs Active Sentences

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, the person or thing that undergoes the action or has its state changed. http://en.wikipedia.org/wiki/Passive_sentence Passive…

Read More Read More

1 Shares
Technical Writing | Interviewing SMEs

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 of talking to and working with SMEs. You will no doubt find, like me, that…

Read More Read More

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

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 as in both cases the interviewer…

Read More Read More

6 Shares
Technical Writing | The risks of poor document management

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 scenario is this: you are sitting…

Read More Read More

1 Shares
Technical Writing | Technical documentation vs Helpdesk

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 user guides is that it is…

Read More Read More

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

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 job title suggests to the uninitiated…

Read More Read More

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

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 did it go? Crucially, did the project achieve its aims of delivering ALL the documentation?…

Read More Read More

1 Shares
Technical Writing | Why your business needs Technical documentation

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 You have no metrics against which to measure current projects You have no information which…

Read More Read More

Documentation projects, before, during and after

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 you make to ensure you complete the project within budget? Here follows the best advice…

Read More Read More

2 Shares
%d bloggers like this: