miércoles, julio 23, 2008

No lo van a leer!! (TAGRI)

Continuamos con los principios. Este esta relacionado con la documentación. TAGRI significa They ain't gonna read it. No creo que haya alguien que dude este principio, la documentación no siempre se lee (¿Es gratificante hacer la documentación para usuarios?).

Este concepto se complementa con el que enuncie ayer, YAGNI. La idea de las metodologías ágiles es crear documentación 'ágil' que refleje las necesidades reales de la audiencia de la documentación. La mejor manera de hacerlo es trabajar lo mas cercanamente posible con la gente para la cual uno esta documentando.

Estos son problemas típicos de la documentación en el software:
  • Projects with detailed requirements specifications fail and/or to have the development team ignore portions of the specification because they believe they know better.
  • Detailed architecture documents be created by a project architect only to have the developers take their own approach anyway, even when the original architecture was pretty darn good.
  • Detailed test documents created only to be discarded at the end of the project because the development team has run out of time.
  • Documents created put on the shelf and ignored after they passed the documentation review.
La solución se basa en cumplir las siguientes reglas:
  • Treat documentation like any other requirement. Any document, even if it's IT related, should be costed, prioritized, and treated like any other system requirement.
  • Create documents with a clear audience.
  • Work with the true audience to identify their actual needs.
  • Write agile documentation: any documentation that you do write should be just good enough for your current situation.
  • Single source information: When you single source information you strive to record it in one place and one place only.
Les recomiendo que lean la fuente de este articulo, que contiene cuatro anectodas muy interesantes.

No hay comentarios.: