How to Write Your First Technical Documentation Plan

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 […]

NEW: 10 Business Proposal Templates (MS Word and Excel)

Since we started the site in 1997, the business proposal templates have been the most popular by far. The User Guides come second. However, for some reason, we didn’t update them for quite a while. Not sure why as we do a lot of freelance proposal writing and should (read: will) add more proposal writing […]

How to Start Writing REST or Web API Documentation

Let’s say you’ve been asked to document a set of REST or Web APIs, a new area for you. Where do you start? At first this can seem overwhelming. So many new acronyms, terms, jargon, and pieces to fit together. Here’s a suggested approach. Focus on a specific api,  for example, REST. Ignore the temptation […]

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 […]

How to Fix Typos in MS Word Automatically

To automatically detect and correct typos, misspelled words, and incorrect capitalization, use the AutoCorrect feature in Word. For example, if you type erport plus a space, then AutoCorrect replaces what you have typed with “report.” Or if you type ‘Teh Executrie summary states’ with a space, AutoCorrect replaces what you have typed with “The Executive […]

Autocorrect: How to fix errors in MS Word

Here’s a quick tip to AutoCorrect errors as you type in Word: Capitalization options – AutoCorrect can capitalize the first word in a sentence, the names of days of the week, the first letter of text in a table cell, and so on. AutoCorrect entries – AutoCorrect can use a list of built-in corrections, called […]