TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Client Questionnaire (P2 of 2) From:Judy Fraser <jfraser -at- GLINX -dot- COM> Date:Mon, 4 May 1998 13:45:50 -0300
And, here's part 2:
1. What is the primary education level of your users? Secondary level?
2. What technical background do your users have?
3. What is your users' native language?
4. What is their level of familiarity with computers?
5. Have your readers used similar products?
6. Why are they using your product?
7. How often do they use your product?
8. At what organizational level are the users? (e.g., clerical, engineers, management, etc.)
9. Will I be able to run the software on my computer, or do I need access (dedicated machine) at your site?
10. What information is/is not included in the document? (E.g., what assumptions are made about your users; do they already know how to use a computer, windows, etc.)
11. In what kind of environment will the document(s) be used? (E.g., in the field, in an office, on or near an assembly line, etc.)
12. What questions does your help desk/support staff frequently receive from users?
13. What style of writing would be most appropriate to your readers? (e.g., contemporary, elegant, professional, informal, formal, technical, or a combination)
14. How do you want to distribute the information? (hard copy, network, CD, etc.)
15. How may you want to distribute information in the future? (e.g., hard copy now, but on line help later)
16. What page size will be used for hard copy documents? (e.g., 8 1/2 x 11, etc.)
17. Is the final hard copy document to be black and white only or color?
18. How do you want the final documents delivered? (Hard copy, electronic (email, diskette))
19. Will the document(s) be translated? What language? Do you have someone/firm to do this?
20. Who are my technical contacts (SMEs) for this project and what are their positions?
21. Is there a procedure to follow to get answers to questions? (E.g., can I talk to the programmer, etc. directly, should I use email, schedule appointments, etc.)
22. Get names, titles, email addresses, phone numbers, etc. of SMEs.
23. What is the development/project team's view of documentation? Do they feel it's important to the final product or a "necessary evil"?
The Review Process
24. What is your standard review process?
25. What is the approval process for the documentation?
26. How many people need to review it and who has the final word/sign-off authorization?
27. Is there potential for the product or process to kill or hurt someone, or to damage property?
28. If yes, to above, will a legal representative review the document(s)?
29. Do your developers schedule time for document reviews? (If not, tell them to plan to add it.)
30. Can user testing be arranged to ensure the document(s)' usability, readability, clarity, etc.?
31. Where can user testing be held?
32. How will user testing be performed?
33. How will this affect the document schedule? (e.g., add to it, delay it, increase it, postpone finish date?
34. Who will arrange getting the users together and preparing the test facility? (e.g., systems personnel to set up computers; facilities specialist to arrange desks, chairs, overhead projector, white board, etc.; secretary for copying procedures, notifying users, scheduling test room, etc.)
35. Based on experience from previous projects, what is your feel for the time to write the document(s)?
36. What is the timeline for the project? i.e., when should the final document(s) be complete)
37. What phases does the project go through? (E.g., beta; documents adhere to same phases and go through the review process in parallel with those phases.)
38. What is your procedure for handling deadline slips? How can we ensure that I am advised of such situations?
39. How do you wish to handle reviews/milestones?
40. What is your procedure for handling software changes that effect the documentation? How can I be sure I'm advised of such changes?
41. What is your internal name for this project?
42. What is the correct spelling/usage of your corporate name?
43. Who am I reporting to for this project?
44. How do you want to handle status reporting/periodic deliveries?
45. How often do you want invoices submitted? And to whom?
46. How much descriptive info should be on the invoice?
47. What expenses are covered for travel and other needs? (E.g., flight, car rental/taxi, hotel, per diem, ISP, travel/flight insurance, etc.)
48. What receipts are required for expense reporting? (Some companies allow a per diem (e.g., $40.00 per day for meals and incidentals) for which no receipts are required.) Are photocopies acceptable?
49. What concerns/issues do you have regarding telecommuting?
50. If necessary clarify your own work habits, requirements, etc. with the client.
Remember, I welcome any feedback you might be able to offer.
Judy Fraser, B.Sc.
Technical Communications Specialist
PO Box 58, Centreville
Nova Scotia B0P 1J0