Hola a todos,
La documentación es una cosa necesaria pero que raramente apetece hacer.
Cuando hablamos de documentación no me refiero a la explicación del código desarrollado (para eso ya está el propio código y los comentarios) sino a un resumen sencillo de como se trabaja con ese código desde fuera. Es decir, de que funciones dispone un programador al usar nuestro código.
La documentación ha de ser sencilla y clara (y veraz) permitiéndonos en menos 5 minutos saber si esa librería va a cumplir con nuestras necesidades o no.
Si no tenemos documentación, da igual cuan buena sea nuestra librería será complicado usarla, así que no se usará. De la misma manera una documentación demasiado exhaustiva, centrándose en los detalles también es contraproducente ya que dificulta el aprendizaje inicial de nuestro producto, haciendo que la gente tampoco use nuestra librería.
Sin más , os dejo con la documentación del pakengine en el siguiente link.
La documentación está en castellano, catalán e inglés, aunque estos dos últimos los tengo traducidos a medias, si queréis acceder a la versión castellana la tenéis ya al 100%.
Espero que os guste y os sirva.
Nos vemos
0 comentarios :
Publicar un comentario