3 ms·
I wonder if he has hard data about how often people look at his documentation. I generally agree with everything he wrote. One page quick start, focus on getti
by PainfullyNormal 4y ago
I wonder if he has hard data about how often people look at his documentation.
I generally agree with everything he wrote. One page quick start, focus on getting things working, people will dig into writing code right away. Yes, yes, yes. But, then what? People tend to read documentation extensively when something doesn't work the way they think it should. You can make your API as self-documenting as humanly possible, but there's no way to know if the person using your API is going to be on the same wavelength.
My go-to example here is Ruby. I once got stuck on an interactive ruby tutorial because you're supposed to be able to guess the names of the commonly used functions in ruby. This particular tutorial wouldn't let you pass until you figured it out. I had to google it. For whatever reason, it was not the word I would have chosen. The word they chose makes complete sense in hindsight, but it's simply not the word that comes to mind to me.
I kept running into that again and again with Ruby and later with Rails. I just wasn't getting it. The documentation became very important for me to get anything done.
- lifthrasiir 4y ago> I wonder if he has hard data about how often people look at his documentation. Context: He works for RAD Game Tools, now a subsidary of Epic Games, and worked on the Oodle data compression suite for a long time. As such I believe there were tons of direct customers who would contact him and other team members whenever things went hairy. (There were no free version of Oodle so every user is a paying customer or sometimes an evaluator.) Therefore I guess he does have some data but no hard numbers.