The most excellent technical writer

writer201/ April 7, 2019/ Technical Writer/ 1 comments

As a Technical Author, one question an interviewer asks is what makes a good Technical Author? Based on my 23 years’ experience here is my take on what makes either a poor, a good or an excellent technical writer. Poor technical writers edit the content and leave it at that. There are no questions, no curiosity even when a set

Read More

Project Management and Doucmentation

writer201/ February 20, 2019/ Technical Writer/ 0 comments

The quality of project management has a direct impact on technical documentation, a fact project managers overlook . This article looks at the areas where the relationship between project management and technical documentation intersect.  Put a plan around a project or a project around a plan Technical documentation will suffer if the project is floundering without a project plan. A

Read More

Welcome to the Gutenberg Editor

writer201/ September 11, 2018/ Technical Writer/ 0 comments

The goal of this new editor is to make adding rich content to WordPress simple and enjoyable. This whole post is composed of pieces of content—somewhat similar to LEGO bricks—that you can move around and interact with. Move your cursor around and you’ll notice the different blocks light up with outlines and arrows. Press the arrows to reposition blocks quickly,

Read More

Technical Writing | General Data Protection Regulations

writer201/ January 21, 2018/ Document management, Documentation, GDPR, Process Documentation, Technical Writer, Technical Writing

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 rules is that under GDPR Process activities MUST be documented. Companies are required to maintain

Read More

Technical Writing | Project Managers and Technical Writers

Michael Clark/ January 13, 2018/ Technical Documentation, Technical Writer, Technical Writing

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 taking instructions from SMEs. Occasionally a project manager who has never

Read More

Technical Writing | Passive vs Active Sentences

Michael Clark/ January 11, 2018/ Documentation, Technical Documentation, Technical Writer, Technical Writing

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 or has its state changed. Passive vs Active I can

Read More

Technical Writing | Interviewing SMEs

Michael Clark/ January 9, 2018/ Documentation, Process Documentation, Technical Documentation, Technical Writer, Technical Writing

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 will no doubt find, like me, that some SMEs are difficult

Read More

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

Michael Clark/ January 9, 2018/ Documentation, Technical Documentation, Technical Writer, Technical Writing

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 seemed distracted and uncertain what

Read More

Technical Writing | Sourcing a technical writer

Michael Clark/ January 9, 2018/ Technical Writer, Technical Writing

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 only be an asset to your team or project. The longer

Read More

Technical Writing | The risks of poor document management

Michael Clark/ January 8, 2018/ Document management, Documentation, Technical Documentation, Technical Writer

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 at your desk when your

Read More