3 ms·
Once you need more and more advanced use-cases, I think we all eventually discover that Documentation is damn hard, and no one does it perfectly. In Google's c
by 013a 8y ago
Once you need more and more advanced use-cases, I think we all eventually discover that Documentation is damn hard, and no one does it perfectly.
In Google's case, I see a few major issues constantly with their documentation.
All of their documentation is focused around "use-cases", so to speak. Finding complete API documentation is a pain in the butt for many of their services; instead, they present sections like "Here's how to do X" "Here's how to do Y". More often than not, these pages are structured like help wizards, beginning with a "pull this example repository", which is the laziest possible way to check a "write documentation" checkbox.
Barring pulling those example repositories, they often put code snippets in-line with the documentation. As far as I can tell (at least for Go), these code snippets are auto-generated from comment directives in the source code which enclose blocks to paste into the documentation. What this means is that its ALWAYS missing crucial things, like import paths. So, its basically useless; you need to look at the example code to do anything.
Overall, I'd take AWS's documentation any day, though it does have some very bad areas (specifically once you start treading out of the SDK and into service libraries, like aws-xray-sdk). No one is perfect, but AWS is the gold standard of any cloud service provider documentation I've used IMO.