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:Re: Code examples/templates From:"Jeanne A. E. DeVoto" <jaed -at- jaedworks -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 15 Aug 2001 18:54:30 -0700
At 10:01 AM -0700 8/15/2001, Jane Carnall wrote:
>I'd like to kick this in for discussion. In one of the projects I'm working
>on, we provide (currently 8) code examples/templates. What I did for the
>beta release was comment the code heavily, mark each comment, and refer to
>the comments from the documentation. Now "Ma" below has suggested another
>way of doing it (my response is below) and I really am not sure whether I'm
>for or against it. On the one hand, it would certainly make that chapter of
>the manual easier reading - no flipping back and forth between manual and
>code - on the other, well, see my response under "Me".
The process of reading documentation/flipping to code/searching for marked
comment/flipping back to documentation is irritating enough that I'd be
inclined to avoid it if at all possible. (I do like heavily-commented
example code, however.)
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.
*** 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.
