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 interested in developing procedures for :
(i) dovetailing technical writing with spftware developement processes so
that certain criticial aspects of Technical Writing begin shortly after the
technical specifications are finalised.
As a part of this I am interested to know if anybody uses UML2 Use Case
diagrams ( or other UML diagrams) to develope an outline of Task Based User
manual?
Do you differntiate between Task Based User manual and Feature Based user
manual or both are mixed and matched?
How would you align Tech Wrting steps with Testers passing partial builds?
Such alignment would ensure that Tech Writers catch the changed requirements
as soon as the software teams builds them. Catching them earlier would be
heavenly, but is it practical?
(ii) Procedures for ensuring higher re-use of already developed Techinal
Writing. For example somebody has already explained one type of a Button Use
in a different Product manual. The Button, to be described now has very many
simmilar functionalities in a different product. What proceures would ensure
high reusage of such already debveloped material which has only to be
partially modified to be useful?
This is different from Single Sourcing which focuses essentiallly on format
/ media.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
