lunes
ene082007
Documentación preferida para APIs: artículos cortos (encuesta del mes)
lunes, enero 8, 2007 at 9:45PM
Según los resultados actuales de la encuesta parece que los artículos cortos son la forma preferida de aprender una nueva API, seguida de los comentarios de Javadoc. También parece haber consenso en que nombres de clases y métodos significativos no son suficientes para comprender el API. Y un porcentaje de gente significativo (más del 10%) está votando a "otra" (¿qué otros tipos de documentación preferís utilizar?).
Hubo un tiempo en el que los artículos cortos también eran mi forma preferida de aprender una API. Pero mi voto ha sido para el manual de referencia. Si voy a emplear para un tema muy puntual una API probablemente me conforme con buscar algún artículo en Google. Pero si voy a trabajar en serio con ella quiero conocerla en profundidad y eso no se consigue con artículos cortos (o al menos no lo consigo yo). Para mí el manual de referencia o, si hay, el libro son la mejor fuente.
¿Cuál es tu tipo de documentación preferido y por qué?
Hubo un tiempo en el que los artículos cortos también eran mi forma preferida de aprender una API. Pero mi voto ha sido para el manual de referencia. Si voy a emplear para un tema muy puntual una API probablemente me conforme con buscar algún artículo en Google. Pero si voy a trabajar en serio con ella quiero conocerla en profundidad y eso no se consigue con artículos cortos (o al menos no lo consigo yo). Para mí el manual de referencia o, si hay, el libro son la mejor fuente.
¿Cuál es tu tipo de documentación preferido y por qué?
in
jh
jh 
Reader Comments