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.
> How about, where you have a section of documentation that deals with a
> section of code, incorporating a line or three of that code inline with the
> documentation at that point? Readers can read the entire heavily-commented
> code example, then read the documentation on it, and have the specific line
> being described right there in front of them for easy reference while
> reading.
I would agree with Jeanne. This is how I have been including code samples into
the JSP web site I'm working up, and it has been well-received by the few
people who are previewing my site for me. The readers can go to the source code
to follow the logic flow throughout the whole module, and they can read the doc
for individual descriptions of segments of code.
Great to hear that Jane is tech-savvy enough to be able to comment the code
that she has either created herself or that has been provided to her. (Not to
stir up the whole "does a technical writer need to be technical" debate again!)
__________________________________________________
Do You Yahoo!?
Make international calls for as low as $.04/minute with Yahoo! Messenger http://phonecard.yahoo.com/
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
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.
