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 agree with Suzanne - different fonts can be confusing, plus not everyone
is able to differentiate between two different fonts with ease. I use either
bold or italics to differentiate between what is required and what is
optional. I use courier or some other type of monospaced font for code so
it is easy for people to see if spaces are present. For example, I might use
courier for the entire line of code and apply italics only to the parts that
are optional.
Chantel
-----Original Message-----
From: techwr-l-bounces+brathwaitec=castupgrade -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+brathwaitec=castupgrade -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Suzanne Chiles
Sent: Tuesday, November 30, 2010 2:49 PM
To: Roberta Hennessey
Cc: tech writer tech writer
Subject: Re: Font choices
Different languages have different types of syntax and customs. What
language and OS are you working with?
On a general note, though, I would stay away from using different fonts.
Typically, code examples are written in a monospace font. You can use
italics or bolding.
Suzanne
On Tue, Nov 30, 2010 at 11:29 AM, Roberta Hennessey
<rahennessey -at- gmail -dot- com>wrote:
> Hi.
>
> Can anyone make any recommendations on using font type to differentiate
> required and optional code in a code example?
> I want a programmer to be able to glance at it and be able to tell which
is
> required and which is optional. As this will be both
> online and hard copy, no color is used.
>
> Is there an industry standard for code examples programmers are familiar
> with?
>
> I am using these 2 to differentiate:
>
> Verdana, 12, Italic
> Courier New 13 (greater kerning)
>
> Any suggestions appreciated. I want my guide easy as pie to use.
>
> Bobbi
>
>
>
> --
> Roberta Hennessey
> Technical Writer
> (978) 835-4282
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with
> Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as suzchiles -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/suzchiles%40gmail.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as brathwaitec -at- castupgrade -dot- com -dot-
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
