Category: Documentation

Technical Writing | General Data Protection Regulations

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 rules is that under GDPR Process activities MUST be documented.…

Read More Read More

3 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 | Disaster Recovery Plan

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 company’s servers and their hosted Applications, consider…

Read More Read More

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 | Keep SharePoint working for your Business

Technical writing | Keep SharePoint working for your Business

Companies pay premium rates to have SharePoint installed only to discover their staff continues to use it as a glorified shared drive. So, how do you stop SharePoint from becoming a free for all? Allowing users to use SharePoint without control raises problems around folders because they create: new multiple folders with obscure titles folders which remain…

Read More Read More

1 Shares
Technical Writing | A brief guide to documentation projects for Project Managers

Technical Writing | A brief guide to documentation projects for Project Managers

A brief guide to managing documentation projects for Project Managers will demonstrate that when done correctly will produce long-term benefits. Here are some examples to help keep your documentation on track. The original writer is not the best person to check their documentation because they very rarely spot their mistakes. Arrange for a peer review…

Read More Read More

%d bloggers like this: