Google Developer Documentation Style Guide vs Microsoft Writing Style Guide: A Practical Comparison

In professional software documentation, consistency is not a cosmetic luxury; it is the cornerstone of trust. When a developer encounters one page using second person ("you configure the endpoint"), another using passive voice ("the endpoint must be configured by the administrator"), and a third using first-person plural ("in this guide we will configure"), cognitive load multiplies and the documentation feels fragmented.

To eliminate inconsistency, the software industry relies on two monumental, open-source editorial authorities:

  1. The Google Developer Documentation Style Guide

  2. The Microsoft Writing Style Guide
  3. Both style guides aim for clarity, accessibility, and precision. However, their design philosophies, tonal recommendations, and formatting conventions diverge in significant ways. In this guide, we analyze both standards side-by-side.

    ###CODEBLOCKPLACEHOLDER0###

    1. Rule-by-Rule Direct Comparison

    A. Heading Capitalization

    • Google Developer Style: Strictly Sentence Case for all headings and document titles. Capitalize only the first word and proper nouns.
    • Google Example: Configure mutual TLS for ingress controllers
    • Rationale: Sentence case is easier to read, avoids ambiguity over whether short prepositions (e.g., "with", "from") should be capitalized, and simplifies localization into European languages.
    • Microsoft Style: Recommends Sentence Case for web documentation, but historically permitted Title Case for marketing headlines and product titles.
    • Industry Consensus: Most modern developer portals standardize on Google's sentence-case rule for all technical documentation headings.
    • B. Voice, Person, and Tone

    • Google Developer Style:
    • Second Person ("You"): Address the reader directly as "you". Never use "we" (the royal we) or "the user".
    • Active Voice: The subject must perform the action. Avoid passive constructions.
    • Avoid: "The database cluster is provisioned by the worker node."
    • Use: "The worker node provisions the database cluster."
    • Imperative Mood for Instructions: Start instructional steps with active verbs: "Click", "Run", "Specify", "Download".
    • Microsoft Style:
    • Shares the emphasis on second person and active voice, but places stronger emphasis on a warm, conversational, and empathetic tone.
    • Encourages contractions ("it's", "you'll", "don't") to make documentation sound natural and human, whereas Google allows contractions judiciously but warns against overusing them in formal API references.
    • C. The Oxford (Serial) Comma

    • Google Developer Style: Mandatory. Always use the serial comma before the coordinating conjunction in lists of three or more items.
    • Google Example: "Deploy the container, inspect the ingress logs, and verify the health check probe."
    • Rationale: Eliminates grammatical ambiguity in technical specifications where compound list items could be misinterpreted as a single entity.
    • Microsoft Style: Mandatory. Microsoft also requires the Oxford comma in all technical and consumer documentation.
    • D. Formatting UI Elements, Code Symbols, and File Paths

      Content TypeGoogle Style Guide RuleMicrosoft Style Guide RuleExample
      Code identifiers (functions, classes)Inline backtick code fontInline backtick code font` TelemetryClient
      File paths and directoriesInline backtick code fontInline backtick code font /etc/dtw/config.yaml
      UI buttons and menusBold textBold textClick Save Changes
      Keyboard shortcuts or Bold + Key nameBold key names with plus signPress Ctrl+C
      Terminal command promptsOmit the $ prefix in snippetsOmit the $ prefixnpm install @dtw/cli`
      Notice the critical consensus on terminal prompts: Both Google and Microsoft strictly instruct writers never to include the $ or > command prompt symbol inside copy-pasteable terminal blocks. When a developer clicks the copy button, including $ causes the pasted command to fail with a syntax error in their terminal!

      2. Inclusive Language and Global Accessibility Standards

      Both style guides lead the technology industry in advocating for inclusive, bias-free, and accessible technical communication:

    • Gender-Neutral Pronouns: Always use singular "they" or rephrase sentences to avoid gendered pronouns ("he" or "she").

    • Culturally Inclusive Terminology: Replace militaristic, colonial, or exclusionary jargon with precise technical equivalents:

    • Replace whitelist / blacklist with allowlist / denylist.

    • Replace master / slave with primary / secondary or leader / follower.

    • Replace sanity check with coherence check or quick validation.

    • Replace dummy data with sample data or synthetic test values.

    • Screen Reader Considerations: Avoid relying on visual-only directional instructions like "in the box on the right" or "click the green icon above". Always describe elements by their functional label: "Select the Deploy button in the navigation toolbar."

    • Descriptive Link Text: Never write "click here" or "learn more". Screen reader users navigate pages by listening to a list of links out of context. Always use descriptive hyperlink text: "For authentication parameters, review the OpenAPI Authentication Guide."


3. Formatting Numbers, Dates, and Technical Units

Precision in numbers and dates prevents international operational misinterpretations:

  • Dates and Times: Always use ISO 8601 format (YYYY-MM-DD, e.g., 2026-10-08) or write out the month in full (October 8, 2026). Never use slash-separated numbers like 08/10/2026, which mean August 10 in the United States but October 8 in Europe and India!

  • Data Sizes (Binary vs Decimal): Clearly distinguish between decimal storage units (megabyte, gigabyte: $10^6$, $10^9$) and binary memory units (mebibyte, gibibyte: $2^{20}$, $2^{30}$, abbreviated as MiB and GiB).

  • CLI Flag Documentation: Follow POSIX and GNU command-line documentation standards:

  • Required parameters are enclosed in angle brackets: dtw cluster deploy

  • Optional parameters are enclosed in square brackets: dtw cluster deploy [options]

  • Mutually exclusive choices are separated by pipes inside brackets: [--json | --yaml]
  • 4. Words to Avoid: Anti-Patterns in Technical Writing

    Both style guides wage war against condescending, wordy, or culturally insensitive words. Below is a compiled dictionary of prohibited terms and recommended replacements:

    Avoid TermWhy It Harms Technical CommunicationPreferred Alternative
    Simply / Just / ObviouslyCondescending. If the reader encounters an error during a step labeled "simply", they feel alienated.Delete the word completely. State the action plainly.
    In order toWordy filler phrase.Use "To".
    Whitelist / BlacklistCulturally insensitive and imprecise terminology.Use Allowlist / Denylist.
    Master / SlaveCulturally insensitive terminology.Use Primary / Secondary or Leader / Follower.
    AbortingHarsh and ambiguous in consumer interfaces.Use Cancel or Stop.
    Above / BelowInaccessible for screen readers and breaks on responsive mobile reflows.Use Preceding / Following or link directly to the section.
    PleaseUnnecessary filler in procedural steps. Technical documentation is professional instruction, not personal correspondence.Use direct imperative verbs ("Enter your API key", not "Please enter your API key").

    5. Automating Enforcement via Vale Style Rules

    Memorizing hundreds of style guide rules is impossible for software engineers submitting sporadic documentation pull requests. Automate compliance using Vale:

    ###CODEBLOCKPLACEHOLDER1###

    ###CODEBLOCKPLACEHOLDER2###

    6. Deprecation Notices and Breaking Change Warnings

    How you warn developers about imminent breaking changes or phased API retirements dictates whether migrations proceed smoothly or trigger angry customer support escalations:

  • Google Developer Documentation Standard: Google mandates high-contrast admonition banners (> [!WARNING]) placed directly beneath the affected heading. The notice must specify the deprecated version, the scheduled sunset date, and an explicit hyperlink to the migration guide:

  • ###CODEBLOCKPLACEHOLDER3###
  • Microsoft Writing Style Guide: Microsoft emphasizes clear, actionable customer outcomes and empathetic framing. Rather than abruptly declaring a feature dead, provide proactive guidance on what modern capabilities the customer gains by upgrading.


  • 7. Spelling, Hyphenation, and Tech Compound Words

    Punctuation and compound word consistency distinguish professional developer portals from hurried blog posts:

    Term / CompoundNoun FormVerb FormAdjective FormUsage Example
    Log in / Loginloginlog inloginUse your login credentials to log in to the dashboard.
    Set up / Setupsetupset upsetupRun the setup script to set up your environment.
    Open sourceopen sourceN/Aopen-sourceThis library is open source; install the open-source package.
    Back end / BackendbackendN/AbackendThe backend service handles distributed ingestion.
    Plugin / Plug-inpluginN/ApluginModern style guides universally drop the hyphen: plugin.
    Email / E-mailemailemailemailAlways unhyphenated: email.

    8. Synthesis: Building an Organization Style Guide

    Rather than authoring an internal style guide from scratch, modern technology companies adopt an existing foundation and document explicit company overrides:

    ###CODEBLOCKPLACEHOLDER4###

    By standardizing on proven style guides and automating rule enforcement in CI, your technical documentation maintains a unified, professional voice across hundreds of contributors.

    NA

    Written by Nuhman Areekode

    Technical Writer & Cloud Documentation Specialist. Focused on documenting distributed systems, OpenAPI specifications, and Docs-as-Code workflows.

    Related Technical Guides