Skip to main content

Naming Conventions

Summary​

This standard defines stable naming rules for documentation files, folders, identifiers, headings, assets, and anchors.

Audience​

  • Documentation authors
  • Documentation maintainers

Reference Content​

Files and folders​

  • Use lowercase kebab-case for Markdown files, folders, and asset names.
  • Use descriptive nouns for concepts and references.
  • Use action-oriented names for task pages.
  • Keep names stable after publication; use a deliberate redirect when a route must change.
  • Reserve README.md for a folder landing page.
  • Do not encode version, status, owner, or date in a filename unless the content model requires it.

Document identifiers​

Use lowercase kebab-case for id. An identifier must be unique within its documentation scope and must not change when a title is edited.

Titles and headings​

Use sentence case. Use one level-one heading per page. Do not skip heading levels. Keep sidebar labels shorter than page titles when necessary without changing meaning.

Assets and anchors​

Name assets after their subject and purpose, followed by a meaningful variant when needed. Use explicit anchors only when stable inbound links require them. Never reuse an identifier or asset name for unrelated content.

See Also​

Keywords​

  • Naming conventions
  • Document identifiers

Revision Information​

  • Last reviewed: 2026-07-14
  • Owner: documentation-team
  • Status: Approved