Instituto de Educación Superior Tecnológico de Desaguadero
Arquitectura de Plataformas y Servicios de Tecnologías de la Información
“Año de la recuperación y consolidación de la economía peruana”
____________________________________________________________________
Estructura de un Manual Técnico Profesional
El manual técnico debe presentar toda la información necesaria para comprender,
mantener y mejorar una aplicación web. A continuación se describe su estructura
recomendada:
1. Introducción
• Presenta el propósito del documento y del sistema.
• Indica quién elaboró el manual, la versión del software, la fecha y el entorno
donde fue desarrollado.
• Incluye una breve descripción del problema que resuelve el sistema y los
objetivos del proyecto.
Ejemplo:
Este manual técnico documenta la aplicación web “Gestión de Inventario Escolar”,
desarrollada con PHP, MySQL y JavaScript. Describe la arquitectura, configuración y
funcionamiento general del sistema.
2. Arquitectura del sistema
• Describe cómo está estructurado el sistema a nivel técnico (cliente-servidor,
MVC, capas lógicas, etc.).
• Muestra diagramas de arquitectura, estructura de carpetas y componentes
principales.
• Explica las tecnologías empleadas: PHP, HTML5, CSS3, JavaScript, MySQL,
etc.
Ejemplo:
El sistema sigue una arquitectura en tres capas: presentación, lógica y datos. Utiliza el
patrón MVC para separar la lógica del diseño de interfaz.
3. Base de datos
• Incluye el diagrama entidad–relación (E-R) o modelo lógico.
• Describe cada tabla, sus campos, tipos de datos y relaciones.
• Explica los procesos de respaldo, restauración y conexión con PHP.
Ejemplo:
La base de datos inventario_db contiene las tablas productos, categorías, usuarios y
movimientos.
Instituto de Educación Superior Tecnológico de Desaguadero
Arquitectura de Plataformas y Servicios de Tecnologías de la Información
“Año de la recuperación y consolidación de la economía peruana”
____________________________________________________________________
4. Flujo de datos
• Representa cómo la información circula dentro del sistema (entrada,
procesamiento y salida).
• Puede incluir diagramas de flujo o pseudocódigo.
• Explica la interacción entre formularios, scripts PHP y base de datos.
Ejemplo:
El usuario ingresa un producto → el sistema valida los datos → los guarda en la tabla
productos → muestra el registro actualizado en la interfaz.
5. Código fuente
• Contiene fragmentos representativos del código con comentarios explicativos.
• Los comentarios deben describir la función de cada bloque sin repetir lo evidente.
• Ejemplo de comentario correcto en PHP:
// Verifica si el usuario existe antes de iniciar sesión
if (password_verify($clave, $usuario['clave'])) {
iniciarSesion($usuario);
}
6. Pruebas y validación
• Explica las pruebas realizadas (unitarias, funcionales, de seguridad).
• Incluye capturas de pantalla de las pruebas y resultados esperados.
• Describe los errores encontrados y cómo se solucionaron.
Ejemplo:
Se realizó una prueba de ingreso incorrecto al formulario de login. El sistema respondió
con el mensaje: “Usuario o contraseña inválidos”.
7. Anexos
• Contiene material complementario:
o Guías de instalación o configuración.
o Listado de librerías y versiones.
o Evidencias gráficas, diagramas, reportes, etc.
Ejemplo:
Anexo 1: Capturas del panel de control.
Anexo 2: Script SQL para crear la base de datos.
