microsoft-365-docs icon indicating copy to clipboard operation
microsoft-365-docs copied to clipboard

Descriptions are lacking and/or inaccurate

Open poortom1004 opened this issue 2 years ago • 3 comments

The feedback below refers to the table listed in Device Properties section of this page.

It would be helpful if you specified where to find the property information for an attached device, for example in Device Manager. You're leaving it up to the reader to figure this out. It would also be beneficial if you listed the exact Device Manager property name that maps to these properties in the description.

Device class

The Description's first sentence talks about Device ID, instead of Device Class, which is irrelevant to Device Class. There is also no example of how to specify the Device class property. Do you use the Class property, or the ClassGuid property? Primary ID property - There is no example of how to specify the Primary ID property, and there is no direct reference in Device Manager for this property, so I have absolutely no idea how to define this, or what the purpose of this property is.

Instance ID

You are leaving it to the reader to figure out what is being stated for this property and some of the other properties. For example the Instance ID description states

A string uniquely identifies the device in the system, for example, USBSTOR\DISK&VEN_GENERIC&PROD_FLASH_DISK&REV_8.07\8735B611&0".

This would be better worded as "A string that uniquely identifies the device in the system..."

Friendly Name

I'm not sure what I can say about the Friendly Name property. The description is horrible and where do I get it from? What property name in Device Manager is this referencing?

A string attached to the device, for example, Generic Flash Disk USB Device

What does "A string attached to the device" even mean? What property name can I get this from in Device Manager?

Vendor ID / Product ID

There is no example or where you get this from in Device Manager.

Serial NumberID

There is no example or where you get this from in Device Manager.


Document Details

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

poortom1004 avatar Mar 12 '22 23:03 poortom1004

@denisebmsft Please help us in resolving this issue. Thanks

yogkumgit avatar Mar 18 '22 13:03 yogkumgit

Hello @yogkumgit! I have opened a work item (6246506) for our team. I don't know the exact timing on this but will track it. I'll post an update here as soon as I know more.

denisebmsft avatar Jul 13 '22 16:07 denisebmsft

@yogkumgit the work item is assigned, and the writer needs some help from the PM. We're waiting on that.

denisebmsft avatar Jul 26 '22 17:07 denisebmsft

Hello @poortom1004. Thank you again for letting us know about the documentation issue. The article has been updated and republished. https://github.com/MicrosoftDocs/microsoft-365-docs-pr/pull/15415

denisebmsft avatar Sep 02 '22 20:09 denisebmsft