Please enable JavaScript.
Coggle requires JavaScript to display documents.
Estructura de la documentación de usuario - Coggle Diagram
Estructura de la
documentación
de usuario
Estándar IEEE
1063-2001
Recomendaciones
Divisiones
Doc. impresos:
Capítulos, temas y subtemas
Doc. electrónicos:
temas
Páginas con
identificación
única
Modos descriptivos
separados
Partes de documento
Información identificativa
Título
Versión y fecha
Nombre de producto y versión
Organización editora
Tabla de contenidos
Introducción
Audiencia
Alcance y propósito
Descripción de
funcionalidad y del entorno
Información Crítica
Contenido
Componentes recomendados
Información identificativa
Tabla de contenidos
Introducción
Información para su uso
Información de
funcionalidades
Procedimientos
Información de comandos
Mensajes de error
y resolución de problemas
Glosario
Fuentes adicionales
Índice
Capacidad de búsqueda
Manual de usuario
Descripción del sistema
1.1 Objeto
1.2 Alcance
1.3 Funcionalidad
Mapa del sistema
2.1 Modelo Lógico
Descripción del sistema
3.1 Subsistema 1
3.1.1 Pantalla 1
3.1.2 Mensajes de error
3.1.3 Ayudas contextuales
FAQ
ANEXOS
GLOSARIO
REFERENCIAS
Manual técnico
1.- Introducción
2.- Análisis del sistema
2.1 Técnicas de recopilación
de requisitos
2.2 Antecedentes
2.3 Definición de Caso de Estudio
2.4 Objetivo
2.5 Justificación
2.6 Especificación de requerimientos
2.7 Modelo de proceso
2.8 Diagrama Entidad Relación
2.9 Diagramas de flujos de datos
Diseño del sistema
3.1 Diseño de datos
3.2 Diseño de interfaz
3.3 Diseño Arquitectónico
3.4 Diseño de Componentes
4.- Codificación del sistema
Pruebas del sistema