|
|
|
|
|
This work directly benefits the technical writer in all subsequent releases, because the software engineers will start maintaining their reference material and reusing your templates for new code items.
The technical writers efforts also provides some good public relations with software engineering if re-formatting and re-writing of code comments does not fall in bulk onto the software engineers to-do list.
Lets not forget the benefits to the whole organization through:
Improving the readability of the code.
Helping bring new employees up to speed.
Enforcing coding practices.
Providing a basis for code review.
Easing the burden of the technical publications group.
Providing a comprehensive HTML system to object-code and source-code customers.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02