Document Your APIs Like You're Explaining Them to Your Kid
“Why does it do that?” She was seven, sitting next to me, asking about a box on my screen labeled /getUserSettings. I was halfway through writing documentation for it, and instead of brushing her off, I tried to answer, out loud, like a bedtime story. “Well, this little box lets other parts of the app ask, ‘What does this user like?’ And it answers with things like language, theme, and notification preferences.” ...