Características de la documentación para los sistemas informáticos

	La documentación que se genera durante un proyecto informático puede dividirse en dos grandes tipos: la destinada al usuario y la del sistema.

Dentro de esta última se incluyen la descripción de requisitos, aprobada tanto por el cliente como por el equipo que llevará a cabo el proyecto, y los comentarios incluidos dentro de la programación del código del software.

La documentación que se destina al usuario se tiene que proporcionar con diferentes grados de detalle: desde una visión general, para que el usuario sepa poner en marcha y configurar el sistema, así como conocer sus principales funciones, hasta un manual completo que describa todas las ventajas del sistema y cómo utilizarlo.

En el último caso, se sobrentiende que el usuario tiene un conocimiento lo bastante bueno como para entender un lenguaje más especializado que el de la guía de inicio. Por lo tanto, esta documentación describirá lo que el sistema puede hacer y lo que no puede hacer (de manera que el usuario decida si es lo que necesita o no), cómo utilizar las posibilidades, cómo resolver los problemas que surgen, cuáles son sus cualidades y la forma uso (con detalles para un usuario avanzado), etc.

En cuanto a la calidad de la documentación, debe estar escrita de manera correcta, sin faltas gramaticales ni de ortografía y con un estilo claro (formas activas de verbos en lugar de pasivas, frases cortas en lugar de subordinadas, párrafos cortos, recordar de lo que se trata cuando nos referimos a otro párrafo, etc.).

También es aconsejable disponer de un formato estandarizado para cada tipo de documentación. De este modo, la redacción resulta más sencilla y, gracias a la división del texto en apartados, es más fácil recordar toda la información relevante que hay que aportar en cada caso.

Otros detalles importantes de la documentación que registra el proyecto son los títulos y subtítulos, que tienen que ser explicativos; también se debe procurar que la numeración de los apartados sea consistente.

Para acabar, no está de más recordar que cualquier cambio tiene que aparecer documentado, lo cual significa llevar un correcto registro de versiones. Si lo hacemos, y además señalamos en cada apartado a qué otras partes del sistema pueden afectar las modificaciones, la tarea de mantenimiento resultará más sencilla. De este modo, cada vez que llevemos a cabo un cambio, sabremos qué otras partes del sistema tenemos que probar para estar seguros por completo de que todo funciona de manera correcta.