Hacker Read

AlwaysBCoding · 2016-01-28 18:12:39

It's a good thing they had great documentation... oh wait.

teach | karma 3235 | avg karma 4.13 · | 2016-05-05 05:48:26+00:00

Well, in their defense, most documentation is terrible. You get used to being able to find something in two Google searches that you couldn't find in five minutes looking through the docs.

bobmcnamara | karma 220 | avg karma 1.49 · | 2024-06-12 11:40:14

Now we're never going to get better documentation /$.

moffkalast | karma 7759 | avg karma 1.88 · | 2022-12-29 07:18:27

Turns out good documentation doesn't help anyone if they can't buy the thing eh?

ARandomerDude | karma 5060 | avg karma 3.73 · | 2021-03-20 01:22:43

Regardless of the proximate cause, it's very frustrating when companies don't prioritize good documentation.

ris | karma 4200 | avg karma 2.93 · | 2015-04-09 23:36:21+00:00

...with a history of awful/non-existent documentation.

charlie0 | karma 1030 | avg karma 1.73 · | 2023-05-16 16:35:22

I agree. Most orgs will say they want more/better documentation, but their actions (or lack thereof) shows the opposite.

jbstack | karma 200 | avg karma 3.17 · | 2023-12-09 05:02:57

I'll gladly take long but coherent documentation over poor or non-existent documentation. This is a strange thing to complain about in my opinion.

dack | karma 799 | avg karma 3.94 · | 2024-01-07 15:38:09

There's no reason they can't have amazing documentation, but I imagine they don't because people are going to use the platform anyway. People are basically forced to use it because that's where so many of their customers are, so they can just treat their users like crap and get away with it. Why spend time on documentation when it will probably only cost them money to do so?

Such a sad state of affairs.

reply

geewee | karma 1020 | avg karma 4.21 · | 2022-09-25 00:11:32

I think the documentation is usually pretty great if you can find it. Somehow I never seem to be able to.

premium-concern | karma 155 | avg karma 0.91 · | 2016-10-14 08:46:15+00:00

I stopped taking this seriously after "the documentation is really good".

Not sure whether this is your real opinion or you are just making fun of people who say that.

reply

sloaken | karma 581 | avg karma 0.81 · | 2019-07-24 19:12:23

Documentation is bad when it is missing.

burlesona | karma 15177 | avg karma 8.16 · | 2018-01-21 15:45:46+00:00

Hmm, “lacking documentation” and “great developer experience” seem mutually exclusive to me.

citnaj | karma 126 | avg karma 5.48 · | 2018-11-02 20:32:10+00:00

LOL I think that'll be my go to excuse for lack of documentation for now on....

musicale | karma 7954 | avg karma 1.63 · | 2024-03-21 13:52:36

I wonder if they'll start maintaining decent developer documentation again someday.

fiddlerwoaroof | karma 6113 | avg karma 2.37 · | 2023-10-07 21:33:55

It’s funny how you just can’t win with documentation: either “there is no documentation” or “tl;dr”

kozak | karma 1859 | avg karma 3.05 · | 2019-10-18 15:09:59

Bad documentation covers obvious things very well, and doesn't cover tricky parts at all. This is especially what you get if the writer of the documentation is paid by the amount of written text: there is no incentive to spend time investigating the hard parts, but a lot of incentive to explain the easy parts in too much detail.

tech_junkie | karma 104 | avg karma 3.06 · | 2012-07-14 14:32:10+00:00

Interesting article. I guess it just shows how to circumvent poor documentation.

Zelphyr | karma 5226 | avg karma 4.1 · | 2018-03-14 03:34:18+00:00

On the one hand, I agree with you. On the other; GOD I hope it works because their documentation is loathsome sometimes.

euroderf | karma 2838 | avg karma 0.82 · | 2022-06-21 01:29:53

It is important tho to note that wrong documentation is significantly worse than no documentation.