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.
Kim Forbes is <<...testing an application and need to send my proprosed
interface changes to the programmers. Does anyone have a template to do
this?>>
I would hesitate to propose a template without first talking to the
programmers. In my experience, there's enough variation in preferences
between developers that any template that works well for one will work
poorly for another. For example, one of my colleagues works very well with
online reviews of documents, whereas another needs in-person discussions;
similarly, one works well with typed comments on the interface, whereas
another requires hand-sketched diagrams. So what I'd recommend is that you
talk directly to the programmers so you can discover how each one prefers to
receive your comments, then adopt that procedure. If you're lucky, you'll be
able to develop a single overall approach, with a few minor variations; for
example, you can probably develop a template that most of the developers
accept, then discover which developers require you to discuss your comments
(written in that template) in person. Even if you have to adopt a few
different approaches, the advantages of showing the developers that you care
about their preferences--plus establishing a precedent for discussing things
in person and getting them used to your presence--can far outweigh any
disadvantages from having to customize your approach.
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
"I vowed [that] if I complained about things more than three times, I had to
do something about it."--Jon Shear
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Learn about tools and technologies for user assistance developers at
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
