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.
From:Martin Lakeland <Martin -dot- Lakeland -at- MULTINET -dot- COM -dot- AU> Date:Wed, 18 Nov 1998 14:24:39 +1100
Is anyone out there?
Has anyone tried rewriting a document written by programmers (in programmer
speak) for programmers before?
(in this case a data transformation tool).
The existing document I have been given is currently described as a user
guide but I am wondering if you can write a general user guide for such a
specific audience. Would a general reference guide be more appropriate - but
if this is the case then how do you reword anything if you dont have the
technical knowledge as a writer to redwrite the text.
In other words, is there a technical writer out there who has written a
manual where they have needed to (or felt that they have needed to be) a
programmer first? (rather than slowly accumulate knowledge as they go).
Hope this doesn't sound too confused.