Writing & StyleStyle guide

Formatting Directives in Technical Documentation

Formatting Directives in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Quick answer

Format literal programming directives according to Microsoft’s developer-text convention.

Key details

Core IssueMicrosoft developer-content guidance provides a separate formatting convention for directives.
RegisterMicrosoft technical and professional documentation

Important caveats

Scope Boundary

Apply this to actual language or platform directives; preserve literal spelling and punctuation required by the syntax.

Further guidance

Content

Format literal programming directives according to Microsoft’s developer-text convention.

Purpose

Visually distinguish syntax directives from surrounding explanatory prose.

Sources and evidence

Sources are shown with the role they play in this guide. Historical or style-sensitive claims are kept within the evidence boundary described above.

  1. Formatting developer text elements — Microsoft Style Guide (opens in a new tab)Microsoft · Microsoft Style Guide conventions for formatting programmatic and code-related elements in developer content.

Related guides

Writing & Style

Formatting AI Prompts in Technical Documentation

Formatting AI Prompts in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Attributes in Technical Documentation

Formatting Attributes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Classes in Technical Documentation

Formatting Classes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Code Keywords in Technical Documentation

Formatting Code Keywords in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Code Samples in Technical Documentation

Formatting Code Samples in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it scoped to technical instructions rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Constants in Technical Documentation

Formatting Constants in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Control Classes in Technical Documentation

Formatting Control Classes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Data Formats in Technical Documentation

Formatting Data Formats in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Explore the topic