Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Win32 and .Net docs are great!

Azure and Powershell docs leave a lot to be desired. A lot of the time parameters are vaguely documented, return values completely undocumented. You have to inspect the object returned by a lot of things to get to understand what members and methods it has, and what they mean.

Examples illustrating what formats it expects inputs in? Forget it.



The newest stuff tends to have the worst docs, since they haven't had time to "mature" with corrections and such yet.

In contrast, Win32 which has been around for over 25 years is mostly stable now.


Azure powershell docs are the worst. All you get told is the name of fields, no indication of what they mean, or the expected inputs/outputs.


I assume you have not encountered SharePoint. The SharePoint documentation I could get my hands on - even in books I paid for - was so bad it was like I was living inside some David Lynch interpretation of Ancient Greek myths of divine punishments unleashed upon the worst sinners.

More than once, the "solution" to my problem was a blog post by a SharePoint consultant from India describing some undocumented flag to pass to some obscure command, "but of course, you should never do this on a production system". (I bear no ill will towards Indian SharePoint consultants, to be clear. I just find it really creepy they seem to enjoy this kind of torment.)


This. Sharepoint has to be a beast to work with.


PowerShell is easy to debug though. So I never have a problem with that. I generally program in it without ever looking at any documentation. I just don't need it.

Just get-help -full/get-member everything or export-clixml it. But maybe I've done it for too long, so I don't see the weaknesses anymore.


The docs have to be good. They are the creators, and their docs need-to and are comprehensive.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: