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: Boxes for Code: Summary From:PStubble -at- MICROS -dot- COM To:janice -dot- gelb -at- eng -dot- sun -dot- com, techwr-l -at- lists -dot- raycomm -dot- com Date:Thu, 18 May 2000 17:48:17 -0400
Janice,
I write API documents and programmer guides here at my company. I prefer to
format code snippets in 8, 9, or 10 point Courier font with a 10%, 12.5%, or
15% gray-shaded background (no boxes).
My two cents,
Paul Stubblefield
Senior Technical Writer
MICROS Systems, Inc.
>I got ten responses, and only two people said they
>are still using boxes around code examples, and
>that using a monospace font (generally Courier,
>which we also use), especially combined with an
>indent, was enough. Most people said that use of
>boxes was old fashioned.
>A number of us here feel that way but we needed
>some evidence to back us up.
>Thanks to Yvonne deGraw, Lee Tesdell, Catherine
>Janzen, Anne McDonough, Beth Scudder, Harry Hager,
>David Chinell, Jo Baer, Glen Warner, and Cathy
>Arthur for responding!
