Formatting Placeholders in Technical Documentation
Formatting Placeholders 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.
ReviewedEvidence1 sourceSectionWriting & Style
Quick answer
In Microsoft-style developer documentation, italicize placeholder elements when they represent UI text, and use angle brackets for code placeholders when angle brackets are not part of the language syntax.
Key details
Core IssueIn Microsoft-style developer documentation, italicize placeholder elements when they represent UI text, and use angle brackets for code placeholders when angle brackets are not part of the language syntax.
RegisterMicrosoft technical and professional documentation
Important caveats
Scope Boundary
This page covers placeholder notation in syntax and user input; literal angle brackets that belong to a programming language remain part of that language’s syntax.
Further guidance
Content
In Microsoft-style developer documentation, italicize placeholder elements when they represent UI text, and use angle brackets for code placeholders when angle brackets are not part of the language syntax.
Purpose
Help readers distinguish the literal technical element 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.
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.
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.
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.
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.
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.
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.
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.
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.
