Documentación de Software y Lenguaje C: Conceptos Esenciales para Desarrolladores

Documentación de Programas: Clave para el Desarrollo y Mantenimiento de Software

La documentación tiene gran importancia en el desarrollo y mantenimiento del software. También es crucial para la reutilización del código. No se debe esperar a terminar el programa para documentarlo; la documentación debe iniciarse tan pronto como se comienza el desarrollo.

Componentes Esenciales de la Documentación de Software

La documentación de software se divide en varios componentes fundamentales:

1. Documentación Técnica

   Este documento especifica el diseño de la aplicación, la codificación del programa y las pruebas realizadas para verificar su funcionamiento. Está destinada a personal técnico con el objetivo de asegurar un desarrollo correcto, efectuar las correcciones necesarias y facilitar un mantenimiento futuro rápido y preciso. La documentación técnica se compone de tres tipos de documentos principales:

   • Cuaderno de Carga

     En este documento se especifica el diseño basándose en las necesidades del usuario y se incluye el estudio previo realizado. Está destinado a los programadores que ejecutan el trabajo y debe permitir la división de tareas entre ellos. Debe estar adaptado a las características físicas, al sistema operativo y al lenguaje de programación.

   • Código Fuente

     Contiene el código de los distintos módulos o partes que forman la aplicación, escrito en el lenguaje de programación establecido.

   • Pruebas de Software

     Este apartado detalla la planificación, el diseño y los resultados de las diversas pruebas realizadas sobre el software.

2. Documentación de Usuario

   Es el documento que contiene la información necesaria para que usuarios de diferentes niveles utilicen correctamente la aplicación. La información proviene de la documentación técnica, pero está expresada de manera que los usuarios puedan entenderla, centrándose principalmente en las entradas y salidas del sistema.

3. Documentación de Instalación

   Contiene la información necesaria para poner en funcionamiento la aplicación desarrollada, así como para establecer las normas de explotación.

Introducción al Lenguaje de Programación C: Características y Ventajas

El lenguaje C fue creado por Dennis Ritchie en los laboratorios Bell en 1972. Sus características principales son:

1. Es un lenguaje de propósito general, utilizado para desarrollar sistemas operativos y aplicaciones muy diversas.
2. Ofrece alta portabilidad: los programas creados en una máquina son fácilmente transportables a otros ordenadores y compiladores.
3. Es un lenguaje flexible, adaptable a distintos tipos de aplicaciones y entornos de programación, lo que facilita la creación de programas de fácil modificación.
4. Es el lenguaje predominante en sistemas Unix.
5. Es veloz y potente, lo que permite crear software altamente efectivo.
6. Posibilita la programación estructurada y modular.
7. Aunque es considerado un lenguaje de alto nivel, mantiene características de los lenguajes de bajo nivel.
8. Es un lenguaje compilado.
9. Es muy apropiado para controlar rutinas escritas en ensamblador.
10. No dispone de un editor propio; cada compilador suele incluir el suyo, aunque permite usar cualquier editor de texto basado en código ASCII.
11. La programación modular en C tiende a incrementar el tiempo de compilación.
12. Es un lenguaje poco legible y eminentemente críptico, lo que lo hace difícil de entender. Por este motivo, es fundamental acompañarlo de comentarios explicativos.