search

MicrosoftDocs / sccm-docs-powershell-ref

Configuration Manager PowerShell documentation public repo
https://docs.microsoft.com/powershell/sccm/configurationmanager/
Creative Commons Attribution 4.0 International
26 stars 63 forks source link

Documentation is.... terrible #249

Open SeleniumSulfide opened 2 years ago

SeleniumSulfide commented 2 years ago

[Enter feedback here]

There are no examples. In fact, it's even worse as the placeholders are the only examples. Further, the cmdlet itself is exceedingly unhelpful. I am running a parameterized command and the only feedback I'm getting is "Please enter a valid integer". However, there are no listed integer parameters nor does the cmdlet itself tell me what a parameter needs a "valid integer". FURTHER, the "InputObject" is, in fact, a ConfigurationItem object, not a PSObject. Good god, SCCM devs. Get your stuff together. People depend on this documentation to do their jobs.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

aczechowski commented 2 years ago

Hi @SeleniumSulfide, thanks for the feedback. We have limited resources to maintain the over 1100 cmdlet articles for this module (along with the 3200 articles in ConfigMgr core docs). Starting with version 2002, the article for any new cmdlet should be mostly complete. We have an internal tracking item to go back and pick up older cmdlet articles when we have time, but it's honestly not our highest priority due to relatively low page views.

We rely on community support from members like you to assist. If you have a sample example to share for this cmdlet, you can either share that via this feedback system, or submit an edit to the article to contribute your example. For more information, see How to contribute. I'm updating content for the 2203 current branch release, and will try to address this article at the same time.

Also, please remember and review the Microsoft Open Source Code of Conduct, which outlines the expectations for community interactions in and around docs.microsoft.com. It's designed to help "provide a welcoming and inspiring community for all." I understand your frustration, but ask that in the future you keep your comments and feedback respectful and inline with our code of conduct.

To share feedback on the cmdlet itself, see Feedback for PowerShell.

SeleniumSulfide commented 2 years ago

Hi. I understand there is a lot to do maintaining these modules and packages and documentation. Been there. I do sympathize. HOWEVER, this module/package and its documentation appears to have languished for a LONG time. The cmdlets themselves do not provide good feedback and then the documentation isn't of any help. Therefore I'm left to try and figure it out on my own with the help of stack overflow. I could get in to how many of the parameter sets are unclear or how to access that parameter sets functionality or any of the other myriad issues I've ran in to trying to leverage PowerShell and SCCM. But, I don't have that kind of time.

I stand by my comment. People depend on this documentation to be up to date and helpful. If MS isn't giving y'all the budget to maintain it appropriately, there isn't much you, specifically, can do. But, if no one speaks up nothing changes. Good luck in your maintenance.