Documentation Conventions
This documentation conforms to a set of conventions that attach specific meanings to typefaces used in explanations and procedures.
Item |
Convention |
Explanation / Example |
|---|---|---|
Acronyms |
All uppercase; usually spelled out on first use. |
Customer Care Framework (CCF) |
Book titles |
Title caps, italic. |
See the Visual Basic Custom Control Reference. |
Chapter titles |
Title caps, in quotation marks. |
See Chapter 9, "Extending Forms." |
Code samples |
Monospace. |
Void main () |
Command-line commands and options (switches) |
All lowercase, bold. |
copy command /a option |
Commands on menus |
Bold. |
File menu |
Dialog box options |
Bold |
Click Continue. |
Dialog box titles |
Bold |
Find and Replace dialog box. |
Directory names |
Initial capitalization; internal capitalization can be used for readability |
\\Irstaxforms\audit \\IRSTaxForms\Audit |
Emphasis or new words |
Italic. |
The software includes both client and server components. |
Error message names |
Sentence-style capitalization |
Access denied. |
File names |
Title capitalization; internal capitalization (camel casing) can be used for readability. |
Filename.doc FileName.doc |
Folder and directory names |
Bold in procedures; regular font elsewhere |
Open the NewDocs folder. \\Accounting\Payroll\Overtime |
Menu names |
Bold, title capitalization |
On the File menu… |
Parameters |
Italic |
CFFagentname |
Programming elements (API names, methods, classes, directives, functions, and so on) |
Bold in text; monospace in examples |
filebuf |
Program names |
Title capitalization |
Microsoft Word |
URLs |
Lowercase |
https://msdn.microsoft.com |
Windows, named |
Title caps |
Help window. |
Windows, unnamed |
Lowercase |
document window |