Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/load.php on line 651

Notice: Trying to access array offset on value of type bool in /home/iawalsh1/public_html/technical-writing/wp-includes/theme.php on line 2241

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387
user guide
Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

User Guide Checklist


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Use this checklist to write your User Guide. The checklist will help reviewers determine if the specifications meet the quality criteria and comply with development methodology requirements. Download 4 MS Word User Guide Templates General Information System Overview – introduce the system at a high-level and its relationship to others, if necessary. References – list […]


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

4 Golden Rules of Capitalization in Technical Documents


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

It is ebay or eBay or Ebay? How Technical Writers use capitalization in user guides creates many problems for editors, reviewers, and users. Part of the problem is a lack of guidelines and style guides. What you think looks fine break some style guide rule you were unaware of. The Capitalization of Microsoft A good […]


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

How Much Does It Cost To Write a User Guide?


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

I write all types of technical documents. This is one of the services I provide to clients that works the best for me over the web. One of questions I get asked most every week is something like, ‘how much does it cost to write a user guide?’ How To Price A User Guide There […]


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Writing Technical Documentation for Japanese Readers


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Carsten Mende explains how loan words are used in China and Japan. These are English words that are commonly used in everyday Chinese, (i.e. loaned) but may not translate correctly if taken literally. He looks at how the ‘Chinese and Japanese languages incorporate English terms and how they are used’ and gives suggestions on what to avoid when translating documentation into these languages.


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

User Guide vs User Manual – which one is Right?


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 2448

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Let’s say you’re setting up a new Tech Docs Dept. You need to create new guidelines, style guides and naming conventions. Should you call the user ‘documents’ User Guides or User Manuals? Which one is Right? I was asked this question by a colleague in India who is setting up a Technical Publishing Dept in […]


Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387

Deprecated: Function get_magic_quotes_gpc() is deprecated in /home/iawalsh1/public_html/technical-writing/wp-includes/formatting.php on line 4387