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: Documenting Code/Why Is It So Ugly? From:CASSIN Gilles <GCassin -at- MEGA -dot- COM> Date:Wed, 3 Mar 1999 11:23:55 +0100
Ben Kovitz wrote as an answer to Kathleen Melly
The big problem with code in documents is that often the code is wider
than
the margins, forcing it to word-wrap. Code should *never* word-wrap.
You can cut code lines (may tech magazines do this), provided that you
clearly indicate that fact (the scissors symbol, if available, is easily
understood).
Gilles CASSIN mailto:gcassin -at- mega -dot- com
+33 1 42 75 40 22
My opinions are mine, and neither you nor my company can take credit for
them. YOU can cite them if you think they were of use.
