You are previewing Microsoft® Manual of Style for Technical Publications, 3rd Edition.
O'Reilly logo
Microsoft® Manual of Style for Technical Publications, 3rd Edition

Book Description

Get the latest information on standards for technical writing and editing straight from the experts. This new edition completely updates and expands the industry’s leading guide to creating quality technical documentation and content.

Table of Contents

  1. Microsoft® Manual of Style for Technical Publications, Third Edition
  2. A Note Regarding Supplemental Files
  3. Acknowledgments
  4. Introduction to the Third Edition
    1. How to use this manual
    2. Other reference materials
    3. About the CD
    4. Support Information
  5. 1. General Topics
    1. 1. Documenting the User Interface
      1. Screen Terminology
      2. Dialog Boxes and Property Sheets
        1. Dialog box syntax
        2. Dialog box elements
      3. Unnamed Buttons
      4. Menus and Commands
        1. Menu terminology
      5. Control Panel
      6. Mouse Terminology
        1. Referring to the mouse
        2. Using mouse verbs
        3. Documenting mouse procedures
      7. Messages
        1. Interactive messages
        2. Informative messages
        3. Writing messages
      8. Key Names
        1. Special character names
        2. Microsoft Natural Keyboard key names
        3. Names of keyboard "quick access" keys
        4. Keyboard shortcuts
      9. Command Syntax
      10. File Names and Extensions
    2. 2. Content Formatting and Layout
      1. Art, Captions, and Callouts
        1. Content
        2. Cross-references to art
        3. Captions
        4. Callouts
      2. Cross-References
        1. Blind cross-references
        2. Structure and style of cross-references
        3. Formatting of cross-references
        4. Cross-references in "See Also" sections
        5. Navigation tables
        6. Cross-references to art
        7. Marginal cross-references
      3. Document Conventions
      4. Headings and Subheadings
        1. Heading style and conventions
        2. Organizational guidelines
      5. Line Breaks
      6. Lists
        1. Formatting lists
        2. Bulleted lists
        3. Numbered lists
        4. Unnumbered single-column and multicolumn lists
        5. Term lists
      7. Marginal Notes
      8. Page Breaks
      9. Tables
        1. Capitalization and punctuation
        2. Content
        3. Column headings
        4. Formatting
        5. Footnotes
      10. Notes and Tips
        1. Notes
        2. Tips
        3. Important notes
        4. Cautions
        5. Warnings
    3. 3. Global Content
      1. Global Art
        1. Colors
        2. Images
        3. Localization issues
      2. Examples and Scenarios
      3. Global Syntax
      4. Word Choice
      5. Technical Terms
        1. Using technical terms
        2. Coining new technical terms
      6. Jargon
        1. Testing for jargon
      7. Foreign Words and Phrases
      8. Time and Place
      9. Names and Contact Information
      10. Fonts
      11. Web, Software, and HTML Issues
      12. Additional Globalization Resources
    4. 4. Content for Software Developers
      1. Reference Documentation
        1. Elements of a reference topic
      2. Code Comments
      3. Code Formatting Conventions
        1. Formatting monospace text
        2. Sample code
        3. Keywords in text
        4. Syntax
        5. User output
      4. Coding Style
        1. General rules
        2. Indentation and alignment
        3. Line spacing
        4. Spacing within lines
        5. Naming and capitalization
      5. Logical Operators
      6. COM, ActiveX, and OLE Terminology
        1. General guidelines
    5. 5. Web Content
      1. Titles of Web Pages
      2. Descriptions of Web Pages
      3. HTML Tag, Element, and Attribute Styling
        1. Formatting guidelines
      4. XML Tag, Element, and Attribute Styling
        1. Elements vs. tags
        2. Capitalization
        3. Element name formatting
        4. Attribute formatting
        5. Tag and node formatting
        6. Other formatting
    6. 6. Indexing and Attributing
      1. Indexing
        1. Creating entries
        2. Creating subentries
        3. Page references
        4. Style and formatting
        5. Capitalization
        6. Plural vs. singular
        7. Prepositions and articles
        8. Verbs
        9. Versus vs. vs.
        10. Cross-references in indexes
        11. Order of entries
        12. Alphabetizing indexes
        13. Special characters
        14. Sorting numbers as numbers
        15. Sorting spaces and punctuation
      2. Keywords and Online Index Entries
        1. Order of entries
        2. Style of indexed keywords
        3. Merging keywords from multiple files
        4. Cross-references
    7. 7. Tone and Rhetoric
      1. Tone and the Reader
      2. Bias-Free Communication
        1. Avoid racial, cultural, sexual, and other stereotypes
        2. Avoid stereotypes of people with disabilities
      3. Parallelism
        1. Parallelism in lists
        2. Parallelism in procedures
        3. Parallelism in sentences
      4. Anthropomorphism
        1. Words to watch out for
      5. Humor
    8. 8. Accessible Content
      1. Accessibility Appendix
      2. Accessible Web Pages
      3. Accessible Writing
      4. Accessible Graphics and Design
      5. Acceptable Terminology
      6. Additional Resources
    9. 9. Common Style Problems
      1. Procedures
        1. To merge subdocuments
        2. Procedure lists
        3. Writing procedure steps
        4. Procedure Style
        5. Mouse vs. keyboard procedures
        6. Joystick procedures
        7. Branching within procedures
        8. Supplementary information and text within procedures
      2. Dates
      3. Capitalization
        1. Capitalization of feature names and technologies
        2. Capitalization in the user interface
        3. Capitalization of titles and headings
        4. Capitalization and punctuation
      4. Measurements and Units of Measure
        1. Abbreviations of measurements
      5. Numbers
        1. Numerals vs. words
        2. Fractions as words and decimals
        3. Ordinal numbers
        4. Commas in numbers
        5. Ranges of numbers
      6. Protocols
      7. Names of Special Characters
      8. Telephone Numbers
        1. International phone numbers
        2. Fictitious phone numbers
      9. Time Zones
      10. URLs, Addresses
      11. Company with Product Names
      12. Version Identifiers
        1. General guidelines
      13. Readme Files and Release Notes
        1. Readme text files
        2. Example readme file
        3. Readme Help files
        4. To print a Readme Help topic
      14. Bibliographies
        1. Citing books and printed articles
        2. Citing electronic information
      15. Titles of Publications
    10. 10. Grammatical Elements
      1. Verbs and Verb Forms
        1. Verbs, Nouns, and Command Names
        2. Transitive and Intransitive Verbs
        3. Agreement
        4. Voice
        5. Mood
        6. Tense
        7. Gerunds
      2. Person
        1. First Person
        2. Second Person
        3. Third Person
      3. Noun Plurals
      4. Possessives
      5. Prepositions
      6. Prefixes
      7. Dangling and Misplaced Modifiers
    11. 11. Punctuation
      1. Formatting Punctuation
      2. Periods
      3. Commas
        1. When to use commas
        2. When not to use commas
      4. Apostrophes
      5. Colons
        1. Capitalization after a colon
      6. Semicolons
        1. Formatting semicolons
      7. Quotation Marks
        1. Placement of quotation marks
      8. Parentheses
      9. Hyphens, Hyphenation
      10. Dashes
        1. Em Dash
        2. En Dash
      11. Ellipses
      12. Slash Marks
    12. 12. List of Acronyms and Abbreviations
  6. 2. Usage Dictionary
    1. A
    2. B
    3. C
    4. D
    5. E
    6. F
    7. G
    8. H
    9. I
    10. J
    11. K
    12. L
    13. M
    14. N
    15. O
    16. P
    17. Q
    18. R
    19. S
    20. T
    21. U
    22. V
    23. W
    24. X
    25. Y
    26. Z
  7. Index
  8. About the Author
  9. Copyright