Category Archives: Templates

How to Start Writing REST or Web API Documentation

API documentation template

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 Automatically Fix Typos in MS Word (and insert currency symbols)

You can automatically correct typos, misspelled words, and incorrect capitalization using the AutoCorrect feature in Word. For example, if you incorrectly type erport, AutoCorrect will replace what you have typed with “report.” Or if you type ‘Teh Executrie summary states’, AutoCorrect replaces what you have typed with “The Executive Summary states.” You can also use […]

How to Automatically Typing Mistakes in MS Word

To Automatically Fix Errors in MS Word, follow these steps: 1. Click File, Info, then Proofing. 2. In the Replace box, type a word or phrase that you often mistype or misspell – for example, type Oralce. 3. In the With box, type the correct spelling of the word – for example, type Oracle. 4. […]