Category Archives: Documentation

Technical Writing | General Data Protection Regulations

GDPR On the 25th May 2018 the new General Data Protection Regulations (GDPR), will come into force. Despite ongoing BREXIT negotiations, due to end in March 2019, the Information Commissioner’s Office (ICO) has implied that the UK will enact GDPR. … Continue reading

2 Shares
Posted in Document management, Documentation, GDPR, Process 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 | 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 … Continue reading

Posted in Disaster recovery, disaster recovery plan, Documentation, Technical Writer | 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 | 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 … Continue reading

1 Shares
Posted in Document management, Documentation | Leave a comment

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

Posted in Document management, Documentation | Leave a comment