La documentación del software es importante para que los desarrolladores, clientes y usuarios entiendan completamente el software. La documentación debe incluir los requerimientos del cliente, casos de uso, especificaciones de cada componente, planes de prueba y manuales de usuario. La organización IEEE ha establecido estándares para la documentación del software que guían su entrega y uso.

1. Juan Esteban Silva Morales
LA IMPORTANCIA DE LA
DOCUMENTACIÓN DEL SOFTWARE
La documentación del software va desde
un buen entendimiento de lo que el cliente
desea ver en el software, esto con el
levantamiento de requerimientos, creación
de casos de uso y en general todo lo que
la metodología UML, pueda aportar, hasta
la elaboración de las líneas de código,
donde cada programador o si es un solo
debe entender, que ese software no solo una sola persona lo va a manipular, sino
que pueden ser varias personas, por ende, cada clase, función, método o cada
calculo debe decir que es lo que se pretende hacer, con esto, se logra un mejor
entendimiento de cada línea de código.
Normas para la documentación del software.
La IEEE () ha creado un estándar llamado IEEE 1063-2001, donde se explica que
el nivel de importancia de la documentación como manual de usuario, donde se
dan las pautas, que se deben tener para la entrega completa del software. Esta
norma, da una guía para poder entregar al usuario la documentación de cómo
usar el programa.
Funciones de la documentación de software.
Todos los procesos del ciclo vital del software en el desarrollo de cualquier
software se registran como documentación. La documentación sirve como
información escrita sobre definición de requerimientos, especificaciones generales
del sistema, especificación de cada componente y los planes integrales de prueba
y mantenimiento. Las herramientas de gestión de configuración también son de
gran utilidad en la documentación del software.
Documentación de software para desarrolladores.
La importancia de la documentación para desarrolladores radica en el hecho de
que la primera contiene información sobre las operaciones del sistema de
software. Esta información posibilita la reproducción del software o su adaptación
para mantenimiento. El tipo de información documentada suele valer muchísimo
para la compañía de software. Dicha información podría perderse si no se
documentan, ya que los desarrolladores van y vienen.