Author: writer201

How many technical writers like me receive calls from agencies trying to source a content writer? It is not uncommon as many writing jobs these days appear under the banner of Content Writer. If you want to choose a suitable writer, read on.

One day, I had to explain the difference between our two titles—comparing my technical authoring skill set to that of a content writer.

Would you know the differences between a content writer and a technical author? If you get it wrong, it will be a costly mistake.

So, what do you know about the following job titles?

• • • Technical writer
    • Documentation manager
    • Content Writer
    • Content strategist
    • Content manager
    • Information governance

Technical Writer

First, we have the most comprehensive skill set. We take complex information and make it accessible to people needing to accomplish a task or goal. We must comprehend the process and produce instructions with diagrams.

Before starting a large project, I would ask if they have a strategy identifying the essential documents (the MUST haves). If not, I will create one with a timeline that identifies the production of critical documentation using MoSCoW. Process authors write:

• • • Policies
    • Processes
    • Work Instructions
    • Standards
    • How to guide?

We use SharePoint to manage and control documents. 

In the software industry, you can write a wide range of documents, such as

• • • user guides,
    • detailed design specs,
    • requirement docs,
    • white papers, and
    • manage a back catalogue of previous records.

Technical Author’s Skill-set

• • • Communication skills to write the narrative around the document
    • focussed on detail – without it, the user could make mistakes, or worse, throw the paper away as useless
    • create a consistent process everyone can follow
    • teamwork – impossible to create documents without SMEs
    • technical skills to understand the terminology
    • writing skills go without saying
    • document management,

Document Controller/manager

This role aligns with technical authors; the duties of this role will depend on the industry type. A document manager oversees organisational documents used by employees.

Content Writer and Manager

Content writing produces engaging content for the Web. They’re also responsible for setting the overall tone of the website. Content writers accomplish these tasks by researching and deciding what information to include or exclude from the site.

There are many variations and opinions if you read up on various sites regarding the skill set. These are the most commonly mentioned:

• • • Writing skills
    • Focus
    • Originality
    • Research
    • Customer knowledge
    • SEO and
    • Editorial skills

Content Strategist

The job is to create engaging content that resonates with customers and draws. The writer may have significant knowledge of the business. 

Information governance (IG)

IG is a strategy to manage information to maintain compliance requirements and operational transparency. Organisations must have consistent policies and procedures for distributing content. IG lends itself to information security, storage, knowledge management, business operations, and data management.

The differences. . .

Technical and content writers have common goals, such as solid writing and editorial and research skills. However, what the roles create in terms of content are different. Technical writing requires more specific knowledge. The clue is in the title; we produce technical content.

• • Technical writing must be objective and precise, with no personal opinions.
  • Content writing can contain an author’s opinion, figures of style, etc.
  • Finally, technical writers use a wide range of tools for writing, while Google Docs may be enough for content writing.

To get the job done, choose a suitable writer for your project.

Have you ever thought about the role of a technical writer? This booklet based on my Blogs will give you the highs and the lows of the job.  You might learn something useful.

To buy a copy click on the link below.

• Technical Writing. A Handbook based on my Blogs

I am a senior-level Technical Writer with extensive experience in Content Writing, documentation management, and process analysis. My experience covers medium to sizeable Technical Documentation projects.

Searching for companies needing Technical Documentation upkeep but can’t hire a technical writer full-time.. Any arrangement will be on a contract basis for a fixed period.

My original Technical Writing background was in Banking Software and Retail Software. I later worked in specialist fields, including Operations (data Centres), ITIL, ISO and PCI.

My extensive experience includes OFfice365, SharePoint, Confluence, VISIO and Adobe applications.

If you would like to speak further regarding your documentation requirements, please get in touch with me.

Michael Clark

This book Technical Writing – The Survivor’s Guide is available through Amazon in paperback and Kindle format contains all the Blogs I have written since 2012.

If you want to know how we work, estimate a project, how we view project managers and our role go ahead. Make my day and buy a copy.

Technical Writing – The survivor’s Guide

As Technical Author, an interviewer asks what makes a good Technical Author. Based on my 23 years of 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 instructions do not read correctly. In which case, if that is, you start looking for a new job.

Good technical writers :

• Logically set out the steps starting at A and avoid no detailed Work Instructions leading to Step Z.
• Methodically test the steps
• ensure the content is easy to read and understood by reviewers
• They know their ABCs

Excellent technical writers go a step further – we:

• ask why – who – what – when – where, and how
• analyse the problem the user is experiencing  
• ask how the documentation will solve the problem
• anticipate the issues users could encounter and the questions they will ask when they follow the material.
• Build relationships with teams across the floor
• Use humour and diplomacy to get what we want
• Pretend we are a user reading the document for the first time
• include links to related topics to keep the user briefed

All the above takes time, effort, and creative thinking, but as excellence is a byword, we never feel the pain.

By covering the above points, the documentation will positively impact the business. Excellent documentation boosts user adoption and reduces support services..

Poor project management has a major impact on technical documentation. In other words of you don’t listen to me, we will be up to our necks writing and managing techdocs while everyone else has their feet up and enjoying a few beers. This article delves into the intersection of project management and technical documentation. 

Put a plan around a project or a project around a plan.

Without a proper project plan, technical documentation is at risk of failing.. Those without experience tend to alter objectives and add to the project without heeding the technical writer’s experience and advice.. 

Documentation alone cannot replace a plan, but it can aid in rescuing a struggling project. Taking the time for documentation analysis can help the project by reducing risks and increasing quality..

Frustrated

Experienced technical writers may become frustrated when the project timeline is unrealistic. This happens when:

• working with staff members who have no experience working with documentation and assume it’s a straightforward task
• unworkable deadlines that sacrifice documentation quality and lead to frustration among internal parties

It is worth bearing in mind: 

• Rely on the TA’s knowledge to schedule technical documentation and establish a timeline.
• Writing or migrating content is not an instantaneous process; a failure to work with the writers could lead to counterproductive problems. 
• If the timeline is genuinely tight, develop a list of documentation priorities for users to adopt the product.

A typical breakdown for a technical writing project includes:

• Research the underlying technology and related issues required for the documentation effort.
• Dedicated time for writing.
• Dedicated time for editing. Copy editing and editing for style, clarity, and other issues.
• Dedicated time to review the technical accuracy of the documentation. Never assume that a document is correct. Always create review time for accuracy by SMEs.

Allow sufficient ramp-up time

Technical writers need sufficient ramp-up time to become versed in the product. While ramp-up time is relative, depending on the writer, a project manager can support the writer:

• Supply the technical writer with the hardware and software quickly..
• Provide the system access, usernames, and passwords.

Ramp-up time for technical writers is beyond the learning curve.

Review the reviewers

As a technical writer, it is important to maintain the accuracy of your documentation. Include the time for technical reviews in the project schedule..

• Scheduled time for technical staff, project managers, and other reviewers to review the documentation.
• Time for the technical writers to add the revisions to the documentation.

Can project managers and technical writers get along?

Technical documentation of superior quality necessitates the involvement of technical writers. Effective collaboration between project managers and technical writers can cause improved design and customer support.. Having customers who can solve their own problems without contacting customer support can benefit a company.