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.
Subject:How JavaDoc works with other docs From:"Andrew Dugas" <dugas -at- intalio -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 31 May 2002 10:58:20 -0700
I'm a Frame/Webworks guy dealing with JavaDoc for the first time. My
question to you has less to do with tools and more to do with how JavaDoc
and supplemental documentation co-exist.
I am producing a programmer's guide for one of our products. The main
programmer has provided JavaDoc files in html. I have written two chapters
that add information not included in the JavaDoc.
But how do these things go together???
Do I...
*** Bring the JavaDoc into a Frame book that includes my two chapters and
then product online from that? (Doclet would enable the engineer to deliver
JavaDoc in MIF.)
PRO - I got the tools and love them.
CON - The engineer is emphatic that other engineers prefer using the JavaDoc
html format just as it is. They're familiar with it and know what to expect.
*** Somehow merge the additional chapters/content into JavaDoc?
PRO - Outside engineers get the doc in a preferred format.
CON - I don't have the tools. I'm not afraid to learn, but time it tight all
ready.
*** Deliver two separate documents, the JavaDoc and the supplemental
material
PRO - Easy, easy, easy.
CON - Needless balkanization of docs that really really really should be
together.
-------------------------
Thanks
Andy Dugas
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
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.
