What's Today

Hacker News Front Page · Terence Eden ·

I paid people to try and follow my README

El autor sostiene que probar un README con personas reales permite detectar supuestos, instrucciones confusas y errores que quienes escribieron la documentación suelen pasar por alto. Al pagar a voluntarios para que siguieran las instrucciones en voz alta, encontró problemas concretos y revisó el texto después de cada sesión; afirma que el proceso lo hizo más fácil de seguir y que la conversación humana aporta observaciones que no se obtienen al simular usuarios con un LLM.

Developers suck at writing documentation. We like to say RTFM but often there ain't no FM to R. At best we have a half-arsed collection of notes, some obsolete tips, and a link to a desolate forum full of people asking the same questions again and again. That's no way to treat our users. I naïvely believe there's a better way. As I've written before, you should sit down and actually test your …

Leer la nota completa en shkspr.mobi →