Category Archives: User Guides
Apr
When writing requirements or technical documentation, when should you use Will or Shall? Does it make any difference which term you use? Yes. Writing Requirements: Will v Shall v May Let’s look at when you use each. Will indicates intention. “I will fix this PC” (you intend to) “Shall” indicates obligation. It’s close to a […]
Apr
In the last tutorial, we looked at how to write work instructions. You can also create a worklist for work instructions according to the following criteria: Data on the work instructions, such as: Plant in which the work instructions were created Number of the set of control instructions from which the work instructions were generated […]
Feb
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 […]
May
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 […]
Apr
Use the following guidelines to plan, schedule, and writer the user and support technical documentation for your next software product. Examples of this documentation include user guides, admin manuals, online help, and release notes. Preparing a Documentation Plan involves several different activities. Let’s examine what’s involved. Work Breakdown Structure Template [Learn more about this template here] Depending on the complexity […]
The purpose of screenshots is to compliment the text, not replace it. This means that your screenshots compliment what you’ve written and help orient the reader. They also help reduce anxiety in the reader as they can check if they are on the right window. What to capture Identify where the user needs to perform […]
Jul
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 […]
Jun
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 […]
