Documentacion de un Software

La Documentación de sistema consiste en un conjunto de información relacionada a un sistema determinado que explica las características técnicas, la racionabilidad del sistema, la parte lógica, losdiagramas de flujos, los programas, la naturaleza, capacidades del sistema y cómo usarlo, en otras palabras, la documentación de sistemas es el conjunto de información que nos dice qué hacen lossistemas, cómo lo hacen y para quién lo hacen.

Estándares Básicos de Documentación
Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, estructuradas en carpetas eincluir un índice.
Los diagramas deberán ser claros, no aglomerados y la escrituramanuscrita deberá ser legible.
La documentación deberá ser completa.
Se incluirá una leyenda o explicación de lostérminos utilizados.
La documentación siempre se conserva actualizada.

Para evitar confusiones en las revisiones de la documentación, se desarrollan diferentes tipos de documentos dirigidos a laspersonas que trabajarán con el sistema para facilitar el mantenimiento del mismo. La documentación de un sistema debe ser marcada adecuadamente, bien organizada actualizada y completa; todos los términosutilizados deben explicarse. La documentación se hará disponible a todos los usuarios de acuerdo a sus necesidades

El estilo de redacción de los manuales de documentación debe ser:
Concreto.Preciso, definiendo los términos utilizados (añadir un glosario).
Utilizar párrafos cortos.
Utilizar títulos y subtítulos.
Utilizar formas activas en lugar de pasivas.
No emplear frases largas quepresenten hechos distintos.
No hacer referencia a una información solamente con el número de referencia

Tipos de Documentación
Documentación Manual:
 Este tipo de documentación se efectúa manualmente.Puede documentarse en papel o en algún medio magnético como disquete o CD. Se cuenta con apoyo de software para su confección, como un procesador de texto, planilla electrónica y programas...