4 ms·
It really comes down to having code I can copy-paste. Google's documentation tends to be minimalist, like a research paper. One small example for everything, ju
by spricket 8y ago
It really comes down to having code I can copy-paste. Google's documentation tends to be minimalist, like a research paper. One small example for everything, just enough to cover every feature.
AWS is closer to "copy paste this big blob and modify it a bit". A lot less work for people trying to implement. I'm not planning to read all the documentation, I just want something that works. Google almost forces you to in many cases
- ohaideredevs 8y agoThat's true. Ideally it would be both - very clear explanations WITH code snippets, which are important to avoid missing "that one little thing" for half an hour when writing code from scratch.
- true_tuna 8y agoIt’s more that copy paste. It’s a philosophy of what the documentation is for. If I’m looking at a doc I’m here because I want to do a specific task. The documentation should be task centric like the instructions for a university homework assignment. Imagine you want 30 people to practice a novel task in one evening. You taught them theory in class. Now you want them to try it out. Give them step by step instructions they can use to apply general knowledge to this specific case. When I’m reading about load balancers and certs I don’t need a textbook. I need examples of specific commands. Instructions on using your tool to do my specific task.