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.
I am a new entrant into the field of technical writing. I've done a lot of technical reporting and technical editing in the past but haven't done 'technical writing' as such. For the last 6 months I've been working as a technical writer here in Bangalore,
India. The kind of work we do here is software development for consumption within the organisation. We develop reusable software components that can be integrated into larger system that forms a part of the final product. My job is a little different from
that of a typical technical writer. A technical writer in an end-user software product development company writes mostly for the benefit of the ultimate end-users of the product. The primary requirement in such a situation is to make the writing as lucid
and user-friendly as possible so that it could be understood by a wide cross-section of users. But in my environment, users of the software are actually system integrators who are all technical people having a fairly decent understanding of the software
component in question. So the software cannot be accompanied by a user manual that is typical of an end-user product. The document however should talk about the features, paramaters and variables, interfaces, the working and how the component gets
integrated into the whole system.
Should such a document be called an integration document? Can anyone tell me how to create an integration document and the format to be followed in creating the same? What are the essential elements that needs to go into such a document. I would be happy
to get feedback on this from people who have worked on similar documents in embedded software environments.
Best regards,
Vinay
'Either write something worth reading or do something worth writing´
*********
G P VINAY BABU
e-mail:vinay -dot- babu -at- philips -dot- com
*** 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
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
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.
