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.
I don't know about described and labelled, but they should be set off
from the regular text somehow. Often a different "screen"
monospaced text is used.
I do online writing and have started to enclose all source code
examples within a gold colored borderless table and use a serif font
vrs. the normal sans serif for the rest of the text.
From: train2 -at- sprynet -dot- com
Date sent: Tue, 19 Dec 2000 14:00:11 -0500
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Subject: code examples
Send reply to: train2 -at- sprynet -dot- com
>
> when citing code examples within a document, even if they are there only
> for example, not instruction, should they be described and labeled every
> time???
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.