Writing & StyleStyle guide

Using Inline Includes Inside Sentences

Using Inline Includes Inside Sentences records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Quick answer

Use Microsoft Learn inline-include syntax when a small reusable include belongs within a line or sentence; use block includes for larger reusable sections.

Key details

Core Issueinline include placement
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

Inline and block includes serve different layout needs. Included text should still be written so it remains translatable and independently understandable.

Further guidance

Content

Use Microsoft Learn inline-include syntax when a small reusable include belongs within a line or sentence; use block includes for larger reusable sections.

Purpose

Keep Microsoft Learn source readable, accessible, reusable, and predictable while following current contributor-platform 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. Markdown reference for Microsoft Learn — Contributor guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor reference for Markdown authoring, including headings/navigation, conceptual images and icons, includes, lists/checklists, nonlocalized strings, alerts, comments, tables, and other Learn extensions.

Related guides

Writing & Style

Using Block Includes for Reusable Sections

Using Block Includes for Reusable Sections records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Explore the topic