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.
> So, while we're all here, let's come up with a good way to do this.
> I've used italics for things the user types, small caps for keys
> (such as ENTER or F3), bold for menu commands. I'm not saying
> these are best; just that this is what I've used. And the punctuation
> situation has always bothered me. What does everybody else do?
I'm interested in the consensus on this one, too.
I was taught - and I probably erroneously assumed it was the industry
standard - that anything you read from the screen should be courier, anything
you type in or click on should be bold. However, when indicating a single
key, enclose caps in angle brackets, as in <ENTER> or <CTRL>+<F3>. I was told
never to capitalize words except in these angle brackets. Italics I thought
were reserved for introducing new terms.
|George Allaman | |
|Tech Writer | <clever, meaningful |
|Denver, Colorado | quip which somehow |
|Office (303) 624-1619 | summarizes my life |
|Home (303) 771-8060 | philosophy> |
|Alternate: georgea -at- csn -dot- net | |