Chapter 7. Computer interfaces

Document computer interfaces in an accurate, clear, and consistent way to make it easier for users to meet their goals.

Commands

Apply the correct capitalization and fonts to commands, their parameters, and their options (the values of parameters). Show the syntax of commands, and explain the meanings of the parameters and options.

Capitalization

If the command language is case sensitive, show the commands, parameters, and options as they must be entered from the console, terminal, or keyboard. If the command language is not case sensitive, show the commands, parameters, and options in lowercase. If you write information for multiple operating systems and the command language is case sensitive on one operating system ...

Get The IBM Style Guide: Conventions for Writers and Editors now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.