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.
Re: Editing files that were generated from Javadocs once
Subject:Re: Editing files that were generated from Javadocs once From:eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com To:Nurit Zur <nurit286 -at- yahoo -dot- com> Date:Wed, 23 Aug 2006 14:35:35 -0400
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
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.
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.
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