englishusage.infoUsage · Phrases · Writing
Writing & StyleStyle guide

Avoiding IDE Screenshots for Code Examples

Avoiding IDE Screenshots for Code Examples records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

ReviewedEvidence1 sourceSectionWriting & Style
Quick answer

Prefer usable code blocks instead of IDE screenshots when the purpose is to show code; reserve IDE screenshots for something about the IDE itself.

Key details

Core IssueIDE screenshots for code examples
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

This is Microsoft Learn contributor guidance about code presentation, not a ban on screenshots that are needed to explain the IDE interface.

Further guidance

Content

Prefer usable code blocks instead of IDE screenshots when the purpose is to show code; reserve IDE screenshots for something about the IDE itself.

Purpose

Keep technical documentation readable, reusable, and unambiguous for readers while following current Microsoft Learn contributor conventions.

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. How to include code in docs — Microsoft Learn Contributor Guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor guidance on including code in documentation, including link/code styling, code-block quality checks, screenshots, validation, highlighting, scrollability, bad-code labeling, and in-repository snippet references.

Related guides

Writing & Style

Avoiding Horizontal Scrollbars in Code Blocks

Avoiding Horizontal Scrollbars in Code Blocks records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

Writing & Style

Clearly Labeling Bad Code Examples

Clearly Labeling Bad Code Examples records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

Writing & Style

Using Fenced Code Blocks for Longer Code

Using Fenced Code Blocks for Longer Code records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

Writing & Style

Using Triple-Colon Syntax for Referenced Code Snippets

Using Triple-Colon Syntax for Referenced Code Snippets records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

Explore the topic

Style GuidesTechnical DocumentationMicrosoft Learn Documentation