Re: Editing files that were generated from Javadocs once

[eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com]

CAUTION: I have no familiarity with JavaDocs.

Seems to me that you need to keep some type of database containing 
original and modified text blocks extracted from the code. Hopefully there 
is some unique identifier that you can store with them for identification 
purposes.

Then, when the new code is provided and text is automatically extracted 
the results can be compared with the database. Text that is the same as 
the original gets replaced with the modified text from the database. Text 
modified from the original in the code is re-edited, with the new original 
and modified text added to the database for the next time round.

Each and every time round, you provide a delta file to management to 
highlight changes that have yet been made to the code.

IMO, the healthier approach would be to make management aware of the 
problem. Have QA refuse the documents due to errors in the code (the 
non-updated text). Or, document the wasted hours re-editing and 
re-modifying the text that the developers should have already changed.

Couldn't/Shouldn't the text changed be entered as bugs into your bug 
tracking list? That way, the developers would really be held accountable 
for performing the changes.

Eric L. Dunn
Senior Technical Writer

_______________________________________________________________________________________________________________ 

This e-mail communication (and any attachment/s) may contain confidential 
or privileged information and is intended only for the individual(s) or 
entity named above and to others who have been specifically authorized to 
receive it. If you are not the intended recipient, please do not read, 
copy, use or disclose the contents of this communication to others. Please 
notify the sender that you have received this e-mail in error by reply 
e-mail, and delete the e-mail subsequently. Please note that in order to 
protect the security of our information systems an AntiSPAM solution is in 
use and will browse through incoming emails. 
Thank you. 
_________________________________________________________________________________________________________________ 


Ce message (ainsi que le(s) fichier/s), transmis par courriel, peut 
contenir des renseignements confidentiels ou protégés et est destiné à 
l?usage exclusif du destinataire ci-dessus. Toute autre personne est par 
les présentes avisée qu?il est strictement interdit de le diffuser, le 
distribuer ou le reproduire. Si vous l?avez reçu par inadvertance, 
veuillez nous en aviser et détruire ce message. Veuillez prendre note 
qu'une solution antipollupostage (AntiSPAM) est utilisée afin d'assurer la 
sécurité de nos systems d'information et qu'elle furètera les courriels 
entrant.
Merci. 
_________________________________________________________________________________________________________________ 


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.