Tag Archives: User Guide

How to Write a Software Installation Guide (With Sample Guidelines + Template)

In this tutorial, we look at how to write an Installation Guide. We look at the main sections in an Installation Guide, how to write each section, and provide sample text to help you get started with your technical documents. Instant Download – Buy Here for only $9.99! Download: Click here to learn more about […]

Video: 15 Technical Writing Tips

In this video Ivan shares 15 ways to improve your technical writing. He shows how to design better documents, perform better peer reviews, and write that little bit faster… without reducing the quality of your documents. If you have a question, please leave it on the YouTube channel. 15 Technical Writing Tips Our User Guide […]

7-Step Approach to Proofreading User Guides

What can Kate Winslet teach you about proof-reading technical documents? Watch the movie The Reader and it will make sense. One of the biggest mistakes you can make when revising any technical document, is to do it all in one go. You can’t! 7 Ways to Proofread User Guides Make it easy on yourself and […]

How to Stop MS Word Files From Crashing

If your Microsoft Word files suddenly become huge and start crashing, here’s how to fix it. Sometimes MS Word files explode from 1 to 10 MB in a few minutes? Why? Why Bullet Lists Creates Large MS Word files? The first offender is Bullet Lists. If there is one thing that’s guaranteed to crash Microsoft […]

How to Write Technical Documentation for Chinese Customers

Summary: Writing technical and business documents for Chinese customers requires an understanding of loan words, proficiency levels, and reader’s expectations. [Learn more about this User Guide and Technical Writing Templates] How to Write Technical Documentation for Chinese Customers Carsten Mende explains how loan words are used in China and Japan. These are English words that […]