SfC Home > Writing > Technical Writing >
Reader questions and feedback on technical writing. Also refer to communications, STC, FrameMaker, RoboHelp, indexing, style, procedures, user manuals, Ron Kurtus, School for Champions. Copyright © Restrictions
Answers to Readers' Questions on Technical Writing:
Type of Docs Needed
The following 3 comments and questions have been sent in. They are listed according to date.
List of first 10 items
- Is a technical marketing brochure a technical document?
- Difference between User manual and Training Manual
- Wants to track customers
Is a technical marketing brochure a technical document?
Question
January 23, 2009
A one pager ad in a newspaper or a magazine featuring an equipment, highlighting some of its key technical descriptions (no details). Can this document be already considered a "technical document" or simply a marketing tool? How about a brochure, can it be considered a "technical document" already?
- Philippines
17149
Answer
There can be an overlap of marketing and technical documentation, especially with product specifications and features. Usually, the purpose of a marketing document is to help sell the product, while a technical document concerns how to use the product, repair it, or explain how it works.
Many technical marketing documents are written by technical writers, teaming up with marketing writers.
Difference between User manual and Training Manual
Question
December 5, 2007
I wanted to see if you could explain the difference between a User manual and a Training Manual?
Christine - USA
14908
Answer
When you buy a product--especially software--there is often an instruction manual or booklet on how to use the product. The is the user manual.
On the other hand, if you were a person who sold, made or repaired the product, you might be sent to a training class to learn some specific tasks. The instructor, and perhaps the students, would use a training manual in the class.
Wants to track customers
Question
October 25, 2004
Hello!
My name is Tanya, I am working at the software development company. I am responsible for technical writing: I have to create help files, user manuals, tutorials and specifications. Our company also provides Technical Support Services by chat and phone. I need to track each case of cooperation with the customers.
Could you please send me some sample of the document for proper tracking each contact with the customer?
Tanya - Ukraine
4786
Answer
Although you can track contacts with customers in a document, if your company gets more customers, the method will become cumbersome.
It would be best for your company to use software to track customers. You can use a spreadsheet or database. There are also software packages designed to track customers.
One inexpensive solution is at http://www.lobstersoft.com/sak/index.php. I have not used that software, but something like it could be good to use.
Summary
Hopefully, this reader feedback has helped provide information about Technical Writing issues.
Always do your best
Resources
The following are some resources on this topic.
Websites
Books
Top-rated
books on Technical Writing
What do you think?
Do you have any questions, comments, or opinions on this subject? If so, send an email with your feedback. We will try to get back to you as soon as possible.
Feel free to establish a link from your website to pages in this site.
Where are you now?
Answers to Readers' Questions