Skip to content

📖 [Docs]: PowerShell messaging standard for Write-Verbose vs Write-Debug#54

Merged
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
docs/46-powershell-messaging-standards
Jul 18, 2026
Merged

📖 [Docs]: PowerShell messaging standard for Write-Verbose vs Write-Debug#54
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
docs/46-powershell-messaging-standards

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 18, 2026

Copy link
Copy Markdown
Member

Implements the PowerShell messaging standard for Write-Verbose vs Write-Debug, addressing the acceptance criteria from #46.

New: PowerShell messaging standard

A new guidance page documents when to use Write-Verbose versus Write-Debug:

  • Write-Verbose: user-facing operational progress, decision summaries, and normal troubleshooting context
  • Write-Debug: developer-focused internals, deep diagnostics, and internal state details

Examples and audience explanation included. Instructions for enabling messages at runtime via PowerShell preference variables.

Review checklist

  1. Useful at normal troubleshooting level? → Use Write-Verbose
  2. Internal/deep diagnostic detail? → Use Write-Debug
  3. Unsure? → Prefer Write-Verbose

Deliverables

  • New file: src/docs/Coding-Standards/PowerShell/Messaging.md
  • Updated: src/docs/Coding-Standards/PowerShell/index.md
  • Practical examples and review guidance included

@MariusStorhaug Marius Storhaug (MariusStorhaug) added documentation Improvements or additions to documentation NoRelease No release required labels Jul 18, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 6348490 into main Jul 18, 2026
19 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs/46-powershell-messaging-standards branch July 18, 2026 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define default PowerShell standard: Verbose vs Debug messaging

1 participant