Sean D Wheeler
banner
sdwheeler.bsky.social
Sean D Wheeler
@sdwheeler.bsky.social
Lead Documentarian for PowerShell at Microsoft. Technical Communicator. Teacher. PowerShell champ.

Blog: https://sdwheeler.github.io/sdwheeler/seanonit
Here is the definition for PowerShell - github.com/toptal/gitig...
March 5, 2025 at 9:40 PM
Yes, I would accept a PR for this. We still maintain the 5.1 docs. We don't need repro steps, just a NOTE added to the parameter similar to what we have for `-Include`.
February 14, 2025 at 4:43 PM
The sidebar nav was removed from the Learn platform and replaced with the list of suggested articles. I don't like it, but is it a platform design decision that I, as an writer, can't change.
January 9, 2025 at 1:26 AM
We have a style guide for the docs. There is an unofficial code style guide at: github.com/PoshCode/Pow...
GitHub - PoshCode/PowerShellPracticeAndStyle: The Unofficial PowerShell Best Practices and Style Guide
The Unofficial PowerShell Best Practices and Style Guide - PoshCode/PowerShellPracticeAndStyle
github.com
January 9, 2025 at 12:26 AM
How would you organize the documentation? It is not a simple task. There are lots of different kinds of docs. And docs are written for different purposes and audiences. There is a difference between reference docs and teaching docs.
January 9, 2025 at 12:25 AM
Specifically, the articles in the learn.microsoft.com/en-us/powers... were written by Bruce Payette. It is legacy content that was originally publish as a Word doc. We don't intend to change. It is provided for historical reference. It is was written for v3 and isn't 100% accurate for v7+.
Windows PowerShell Language Specification 3.0 - PowerShell
This Language Specification describe the syntax, semantics, and behavior of the PowerShell language.
learn.microsoft.com
January 8, 2025 at 9:42 PM
Yes, there is an official style. We try to make all of the documentation adhere to our style. Caveats:
1. We maintain over 9000 documents for PowerShell and the PowerShell SDK.
2. Much of that content was written by others, long before I joined the team.
3. We fix the style as we go.
January 8, 2025 at 9:38 PM
This works:

$c.RelatedLinks.Add([Microsoft.PowerShell.PlatyPS.Model.Links]::new('Text','https://url.com/document'))
November 7, 2024 at 9:50 PM
Check the Diagnostics property of the CommandHelp object.
November 7, 2024 at 1:49 AM
The answer is to update the object before exporting to markdown.
November 7, 2024 at 1:47 AM
The help text for the placeholders has to come from somewhere. It is not embedded in compiled commands.
November 7, 2024 at 1:39 AM
No, the older module has the same placeholders. In either version, if you are documenting script-based modules, PlatyPS will include the comment-based help. But there is embedded documentation like that for C#-compiled cmdlets.
November 7, 2024 at 1:35 AM