Home > Store

IBM Style Guide, The: Conventions for Writers and Editors

Register your product to gain access to bonus material or receive a coupon.

IBM Style Guide, The: Conventions for Writers and Editors

Best Value Purchase

Book + eBook Bundle

  • Your Price: $51.04
  • List Price: $87.98
  • Includes EPUB and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    Adobe Reader PDF The popular standard, used most often with the free Acrobat® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.

More Purchase Options


  • Your Price: $35.99
  • List Price: $44.99
  • Usually ships in 24 hours.

eBook (Watermarked)

  • Your Price: $34.39
  • List Price: $42.99
  • Includes EPUB and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    Adobe Reader PDF The popular standard, used most often with the free Acrobat® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.


  • Copyright 2011
  • Dimensions: 7" x 9-1/8"
  • Pages: 416
  • Edition: 1st
  • Book
  • ISBN-10: 0-13-210130-0
  • ISBN-13: 978-0-13-210130-1

The IBM Style Guide distills IBM wisdom for developing superior content: information that is consistent, clear, concise, and easy to translate. The IBM Style Guide can help any organization improve and standardize content across authors, delivery mechanisms, and geographic locations.

This expert guide contains practical guidance on topic-based writing, writing content for different media types, and writing for global audiences.

Throughout, the authors illustrate the guidance with many examples of correct and incorrect usage.

Writers and editors will find authoritative guidance on issues ranging from structuring information to writing usable procedures to presenting web addresses to handling cultural sensitivities.

The guidelines cover these topics:

  • Using language and grammar to write clearly and consistently
  • Applying punctuation marks and special characters correctly
  • Formatting, organizing, and structuring information so that it is easy to find and use
  • Using footnotes, cross-references, and links to point readers to valuable, related information
  • Presenting numerical information clearly
  • Documenting computer interfaces to make it easy for users to achieve their goals
  • Writing for diverse audiences, including guidelines for improving accessibility
  • Preparing clear and effective glossaries and indexes
The IBM Style Guide can help any organization or individual create and manage content more effectively. The guidelines are especially valuable for businesses that have not previously adopted a corporate style guide, for anyone who writes or edits for IBM as an employee or outside contractor, and for anyone who uses modern approaches to information architecture.

Sample Content

Online Sample Chapter

The IBM Style Guide: References

Sample Pages

Download the sample pages (includes Chapter 8 and Index)

Table of Contents

Foreword     xviii
About this publication     xxi
Acknowledgments     xxii
About the authors     xxiv
Chapter 1 Language and grammar     1
Abbreviations     1
  General guidelines     1
  Spelled-out forms of abbreviations     3
  Periods with abbreviations     5
  Latin abbreviations     6
  Abbreviations in headings and titles     7
  Abbreviations in glossaries     7
  Abbreviations in indexes     7
  Abbreviations for units of time     8
Anthropomorphism     8
Articles     10
Capitalization     11
  Capitalization styles     11
  Capitalization and abbreviations     13
  Capitalization and colons     14
  Capitalization and figures     14
  Capitalization in general text     14
  Capitalization in glossaries     16
  Capitalization in headings and titles     16
  Capitalization and hyphens     17
  Capitalization in indexes     18
  Capitalization in interfaces     18
  Capitalization of letters as letters     19
  Capitalization in lists     20
  Capitalization for tables in text     20
  Capitalization of computer-related terms     20
Contractions     24
Prepositions     25
Pronouns     27
  Ambiguous pronoun references     27
   ender-neutral pronouns     27
  Personal pronouns     29
  Relative pronouns     29
Spelling     30
Verbs     31
  General guidelines     31
  Mood     32
  Person     33
  Tense     35
  Voice     35
Chapter 2 Punctuation     37
Punctuation marks and special characters     37
  Individual punctuation marks or special characters     37
  Series of punctuation marks or special characters     39
  Common punctuation marks and special characters     39
Apostrophes     41
  Apostrophes in plurals     41
  Apostrophes in possessives     41
Colons     42
  Colons in running text     42
  Colons in headings and titles     43
  Colons after introductory text     43
  Colons and capitalization     44
  Colons with numbers     45
Commas     45
  Commas between clauses     45
  Commas after introductory words and phrases     46
  Commas between items in a series     47
  Commas with nonrestrictive clauses     47
  Commas as separators in numbers     47
  Commas with quotation marks     48
Dashes     48
  En dashes     48
  Em dashes     48
Ellipses     49
  Ellipses in running text     49
  Ellipses in examples and quotations     49
  Ellipses in user interfaces      50
  Spacing and punctuation with ellipses     50
Exclamation points     51
Hyphens     51
  Hyphens with prefixes and suffixes     51
  Hyphens with compound words     53
  Hyphens and capitalization     55
  Hyphens with numbers     56
  Hyphens with ranges     56
Parentheses     57
  Parentheses with abbreviations, symbols, and measurements     57
  Parentheses to form plurals     57
  Parentheses in running text     57
Periods     59
  Periods in running text     59
  Periods with abbreviations     59
  Periods with file name extensions     60
  Periods in headings and titles     61
  Periods after introductory text     61
  Periods with lists     62
  Periods with numbers     63
  Periods with parentheses      63
  Periods with quotation marks      63
Quotation marks     64
  Terminology for quotation marks     64
  Quotation marks for emphasis     64
  Double quotation marks     65
  Single quotation marks     66
  Quotation marks with other punctuation     66
  Typographical considerations for quotation marks     67
Semicolons     67
  Semicolons between independent clauses     68
  Semicolons between items in a series     68
Slashes     68
  Slashes in running text     69
  Slashes in dates     70
  Slashes in fractions     70
  Slashes in mathematical equations     70
  Slashes in path names     70
  Slashes in web addresses     71
Chapter 3 Formatting and organization     73
Headings     73
  Format of headings     73
  Wording of headings     74
  Punctuation with headings      74
  Abbreviations in headings     75
  Lists     75
  Unordered lists     76
  Ordered lists     76
  Definition lists     76
  Capitalization in lists     78
  Wording of list items     78
  Length of lists     79
  Alphabetization and sorting methods of lists     79
  Punctuation in lists     80
  Lead-in wording     81
  Nested lists     83
Procedures     84
  Introducing the procedure     84
  Writing steps     86
  Indicating optional and conditional steps     88
  Handling nonsequential actions     88
  Ending the procedure      89
Figures     90
  Figure captions and legends     91
  Figure numbering     92
  Figure references     92
  Figure placement     93
  Callouts in illustrations     93
  Screen captures     94
Tables     96
  Text in tables     96
  Formatting tables     97
  Table headings     97
  Highlighting     102
  Notes and notices     110
  Revision indicators     114
Chapter 4 Structure     115
Topic-based information     115
  Task topics     116
  Concept topics     120
  Reference topics     124
  Links in topic-based information     128
Books     131
  Sequence of book elements     131
  Book elements and other items that might be included in a book     132
  Books: Front matter     134
  Books: Back matter     139
White papers     141
  Structuring your paper     141
  Writing your paper     142
  Getting your paper reviewed and edited     142
Chapter 5 References     143
Footnotes     143
  Footnotes in printed information     143
  Footnotes in online information     144
  Footnotes in tables     144
References to printed information     144
  General guidelines     144
  References within the same document     145
  References outside the document     146
References to online information     148
  General guidelines     148
  References to IBM information centers     149
  References to web addresses, protocols, and IP addresses     149
  References to webcasts, web conferences, and other online broadcasts     153
  Linking strategies     153
Chapter 6 Numbers and measurements     155
Expressing numbers     155
  Numerals versus words     156
  Separators in numbers      159
  Ranges of numbers     159
  Alignment of numbers in columns     161
  Fractions, percentages, and ratios      162
  Rounding numbers     163
  Different number bases     164
  Number complements     165
Mathematical equations and operational symbols     165
  Multiplication     166
  Exponents     166
Units of measurement     167
  Abbreviations     168
  Multiple dimensions     169
  Tolerances     169
  Dimension lines     169
  Temperatures     169 
  Multiplier prefixes for units of measurement     170
  Multiplier prefixes for bits and bytes      172
International currency designations     176
  Local currency symbols     177
Dates     178
  Abbreviated forms     179
  Leading zeros     180
  Date ranges     180
Times of the day     181
  Using the 12-hour system     181
  Using the 24-hour system     182
Telephone numbers     182
  National telephone numbers     183
  International telephone numbers     183
  Fictitious telephone numbers     184
Chapter 7 Computer interfaces     185
Commands     185
  Capitalization     185
  Commands, parameters, and options in running text     185
  Commands, parameters, and options in instructions     186
Command syntax      187
  Using text to specify command syntax     188
  Using diagrams to specify command syntax     192
Programming elements     196
  Keywords     196
  Variables     198
Code and command examples     198
Data entry on the command line      201
File names, file types, and directory names     203
Graphical user interface elements     206
  Location of interface elements     206
  Interface element labels     206
  Usage and highlighting for user interface elements     208
Menu instructions and navigation     216
  Menu instructions     216
  Navigation trees     217
  Directories     217
Mouse buttons     218
Keyboard keys     218
  Verbs to use with keyboard keys     218
  Key names     219
  Key combinations     220
Messages     221
  Message types     221
  Components of error, warning, and information messages     222
  Confirmation prompts     230
  References to messages in documentation     231
Chapter 8 Writing for diverse audiences     233
Accessibility     233
International audiences     235
  Style     236
  Grammar     237
  Terminology     240
  Punctuation     241
  Graphics and images     242
Chapter 9 Glossaries     245
Structure of glossary entries     245
Glossary terms     246
Glossary definitions     247
Relationships between terms in a glossary     251
Relationships between the glossary and other information     254
Sort order in a glossary     254
Chapter 10 Indexes      255
Levels of index entries     255
Integration and reuse     255
Size and sorting     256
Index content     256
Index structure     259
  Levels     259
  Locators     261
  Number of subentries     262
  Cross-posting     263
  See and See also references     264
  Other considerations     265
Index entries     266
  Prohibited words     269
Index sorting     270
Appendixes     273
Appendix A. Exceptions for marketing content     274
Appendix B. DITA tags for highlighting     276
Appendix C. Word usage     300
Index     381


Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020