I meant to post this early, but time and the holidays got away from me. But now I am. In the overall scheme of things, it is a small item, but an appreciated one. This is a certificate of appreciation from the company I worked for for seven months in 2009, doing contract work, C.J. Enterprises. It says, “In appreciation for outstanding commitment, contribution and most of all for being a team player. December, 2009.” It was a pleasant surprise when it arrived in the mail. I had no idea it was coming.
Category Archives: technical writing
Manual or Guide
A member of a technical writing discussion group asked if the term should be Manual or Guide for user documentation.
In my experience, both Guide and Manual have been used to mean the same thing. Often, a shortened version is called a “guide,” while the larger, longer manual is called a “manual.”
However, to me, the more important distinction is whether the documentation is a reference manual (or guide) or a how-to manual (guide).
The difference is that a reference manual tells you what features/functions are available, but not necessarily how to engage those features/functions. A how-to manual tells you how to engage at least some of the features/functions available.
Filed under Documentation, technical writing
