Context
PSModule/GitHub needs a clear distinction between Debug and Verbose messaging. This should be defined once in docs as a reusable default for modules and workflows.
Related implementation issue:
- PSModule/GitHub: "Align Debug vs Verbose messaging semantics across commands"
Goal
Define a default documentation standard for PowerShell messaging channels (Write-Verbose vs Write-Debug) that repos can reference.
Proposed Default
-
Write-Verbose
- user-facing operational progress, decision summaries, and normal troubleshooting context
- should help operators understand execution flow
-
Write-Debug
- developer-focused internals and deep diagnostics
- low-level payload/transport details, internal state, and instrumentation
Deliverables
- Add/update a guidance page in this repo describing the default.
- Include short examples of each level.
- Add a concise checklist for reviews:
- is this message useful at normal troubleshooting level? -> Verbose
- is this internal/deep diagnostic detail? -> Debug
- Link the guidance so other repos can adopt it consistently.
Acceptance Criteria
- Published guidance exists and is discoverable.
- Includes practical examples and review checklist.
- Can be referenced by PSModule repos as the default messaging convention.
Context
PSModule/GitHub needs a clear distinction between Debug and Verbose messaging. This should be defined once in docs as a reusable default for modules and workflows.
Related implementation issue:
Goal
Define a default documentation standard for PowerShell messaging channels (
Write-VerbosevsWrite-Debug) that repos can reference.Proposed Default
Write-VerboseWrite-DebugDeliverables
Acceptance Criteria