24 puntos por xguru 2022-06-27 | 1 comentarios | Compartir por WhatsApp

Frameworks y bibliotecas

  • Incorporación lo más rápida posible
  • Actualizaciones fáciles
  • Mensajes de error útiles
  • Valores predeterminados y convenciones sólidos
  • Permitir escapar de la configuración predeterminada
  • Reducir el riesgo mediante dependencias

Documentación

  • Explicar con código (proveer ejemplos)
  • Resolver problemas (responder preguntas)
  • Generar documentación automáticamente (mantener actualizada la documentación de API, etc.)
  • Organizar también las soluciones para los errores
  • Optimizar para lectura rápida
  • Ser precisa (evitar jerga técnica y expresiones idiomáticas)
  • Exponer gradualmente las cosas complejas

APIs

  • No romper los flujos de trabajo de la API (versionado): como Stripe
  • Permitir probar la API rápidamente: Square hace esto muy bien

1 comentarios

 
laeyoung 2022-06-27

“Optimizar para la lectura rápida” me parece totalmente cierto.