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.
IMO, the Microsoft style conventions might not be suitable for APIs or other environments where the symbols Microsoft uses as delimiters (angle brackets, square brackets, etc.) have literal meanings. For example, most programming languages use square brackets to indicate arrays. In Un*x shells, angle brackets and pipes (|)direct input and output.
-----Original Message-----
From: techwr-l-bounces+ltam=ariba -dot- com -at- lists -dot- techwr-l -dot- com on behalf of Dana Worley
Sent: Wed 12/1/2010 8:22 AM
To: Roberta Hennessey; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Font choices
Most (if not all) programmers will be familiar with conventions used for command line syntax:
> 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?
***************************
Dana Worley
Software Product Manager/Manager, Software Support Group
Campbell Scientific, Inc.
Microsoft MVP, Windows Help
www.jestersbaubles.blogspot.com
www.jestersbaubles.com
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 ltam -at- ariba -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-
