Documentación software

3. Proyectos I+D 1UNIDAD 3 Elaboración de una propuesta de desarrollo de
proyecto

4. Plan de trabajo de la unidad 01Introducción| Elaboración de una propuesta de desarrollo de proyecto
Unidad Tema Duración
Teoría /
Práctica
3. Elaboración de
una propuesta
de desarrollo de
proyecto
3.1 Propuesta de proyecto
3.1.1 Documento ejecutivo
3.2 Requisitos del proyecto
3.3 Diseño y modelado del proyecto
3.4 Codificación y pruebas del proyecto
3.5 Documentación del proyecto
3.5.1 Documento técnico
3.5.2 Documentos complementarios
20 / 38

5. Evaluación de la unidad 02Introducción | Elaboración de una propuesta de desarrollo de proyecto
Actividad Evidencia Ponderación
3.1 Redactar propuesta de proyecto Documento Word 5%
3.2 Presentar propuesta de proyecto Presentación ppt/vídeo 3%
3.3 Redactar documento de requisitos del proyecto Documento Word integrando
el punto 3.1
7%
3.4 Presentar los requisitos del proyecto Presentación ppt/vídeo 3%
3.5 Elaborar la arquitectura y modelado de la solución
a desarrollar
Documento Word con
diagramas
10%
3.6 Presentar los modelos de la solución Presentación ppt/vídeo 3%
3.7 Elaborar la matriz de pruebas de la solución
desarrollada
Documento Word 10%
3.8 Documentar el código del sistema Documento Word 15%
3.9 Presentar la solución desarrollada Presentación ppt/vídeo 5%
3.10 Elaborar manual de usuario y técnico de la
solución desarrollada
Documento Word 10%
3.11 Presentar el proyecto final Presentación ppt/vídeo 10%

6. Pie de foto.
03Documentación| Elaboración de una propuesta de desarrollo de proyecto
Documentación
del proyecto
Escribiendo en la agenda. Obtenido de: https://www.freepik.es/fotos-vectores-gratis/cafe">Vector de Café creado por bluelela

7. 04Documentación| Elaboración de una propuesta de desarrollo de proyecto
Capacitación
Entregando el
sistema
Documentación

8. 05Documentación | Elaboración de una propuesta de desarrollo de proyecto
Entregando el
sistema
Es más que solo instalar el sistema.
También está ayudando a los usuarios a
comprender y sentirse cómodos con el
sistema.

9. Pie de foto.
06
Documentación | Elaboración de una propuesta de desarrollo de proyecto
Capacitación
Usuarios: ejercen las funciones principales
del sistema
Operadores: realizan funciones
suplementarias
• Crear copias de seguridad de archivos de
datos
• Definir quién tiene acceso al sistema

10. Pie de foto.
07Documentación | Elaboración de una propuesta de desarrollo de proyecto
Funciones
Funciones de usuario Funciones de operador
manipulando archivos de datos
simulando actividades
analizar datos
comunicando datos
dibujar gráficos y tablas
otorgar acceso de usuario
conceder acceso a archivos
realizar copias de seguridad
instalar nuevos dispositivos
instalar nuevo software
recuperar archivos dañados

11. Pie de foto.
08
Tipos de capacitación
Documentación | Elaboración de una propuesta de desarrollo de proyecto
Capacitación a usuarios
Capacitación a operadores
Necesidades especiales de entrenamiento

12. 09
Capacitación a usuarios
Introduce las funciones principales.
• Gestión de registros: creación, eliminación, recuperación, clasificación
de registros.
• Navegación a través del sistema
• No es necesario un mecanismo interno (por ejemplo, algoritmos de
clasificación, estructuras de datos)
Relata cómo se realizan las funciones ahora, cómo realizarlas más
adelante con el nuevo sistema
• Es necesario tener en cuenta la dificultad del aprendizaje de transición.
Documentación | Elaboración de una propuesta de desarrollo de proyecto

13. Pie de foto.
10Documentación | Elaboración de una propuesta de desarrollo de proyecto
Capacitación a operadores
Se enfoca en las funciones de soporte y aborda cómo
funciona el sistema en lugar de lo que hace el sistema
Se ejecuta en dos niveles.
• cómo abrir y ejecutar el nuevo sistema
• cómo apoyar a los usuarios

14. Pie de foto.
11Documentación | Elaboración de una propuesta de desarrollo de proyecto
Necesidades especiales de entrenamiento
Usuarios poco frecuentes versus usuarios frecuentes
• Ciertas funciones pueden quedar olvidadas
Nuevos usuarios (que han reemplazado a usuarios
capacitados)
El interés de los usuarios existentes en repasar lo
perdido
Necesidad de entrenamiento especializado

15. Pie de foto.
12Documentación | Elaboración de una propuesta de desarrollo de proyecto
Ayudas en la capacitación
Documentos
• Documentación formal, manuales.
Iconos y ayuda en línea
• Los manuales en línea proporcionan enlaces de hipertexto
Demostraciones y clases.
• Más individualizado, más dinámico; usos de multimedia (audición,
visión)
Usuarios expertos (y personas capacitadas)

16. Pie de foto.
13Documentación | Elaboración de una propuesta de desarrollo de proyecto
Pautas para la capacitación
Comprender las preferencias personales, los estilos de trabajo y las
presiones organizacionales.
Necesidad de organizar a diferentes tipos de estudiantes.
Divida una clase de capacitación en unidades de presentación con un
alcance corto y limitado.
Determina el tipo de entrenamiento basado en la ubicación de los
estudiantes.

17. Pie de foto.
14Documentación | Elaboración de una propuesta de desarrollo de proyecto
Documentación
Considere las audiencias
Necesito entender la audiencia prevista
• Los usuarios
• Operadores
• Personal del cliente
• Otro miembro del equipo de desarrollo
Diseñe diferentes documentos para diferentes audiencias.
• Incluya una introducción "amable"

18. Pie de foto.
15Documentación | Elaboración de una propuesta de desarrollo de proyecto
Tipos de documentación
Manual de usuario
Manual del operador
Guía general del sistema
Tutoriales y descripciones generales
automatizadas
Otra documentación: guía del programador

19. Pie de foto.
16Documentación | Elaboración de una propuesta de desarrollo de proyecto
Manual de usuario
Comenzando con el propósito general y progresando a una
descripción funcional detallada
• propósito u objetivos del sistema
• capacidades y funciones del sistema
• características del sistema, características, ventajas

20. Pie de foto.
17Documentación | Elaboración de una propuesta de desarrollo de proyecto
Manual de usuario
Objetivos
Que el usuario conozca cómo preparar los datos de entrada.
Que el usuario aprenda a obtener los resultados y los datos de salida.
Servir como manual de aprendizaje.
Servir como manual de referencia.
Definir las funciones que debe realizar el usuario.
Informar al usuario de la respuesta a cada mensaje de error.

21. Pie de foto.
18Documentación | Elaboración de una propuesta de desarrollo de proyecto
Manual de usuario
Objetivos
Que el usuario conozca cómo preparar los datos de entrada.
Que el usuario aprenda a obtener los resultados y los datos de salida.
Servir como manual de aprendizaje.
Servir como manual de referencia.
Definir las funciones que debe realizar el usuario.
Informar al usuario de la respuesta a cada mensaje de error.

22. Pie de foto.
19Documentación | Elaboración de una propuesta de desarrollo de proyecto
Manual del operador
Configuración de hardware y software.
Métodos para otorgar y denegar el acceso a un usuario
Procedimientos para agregar y quitar periféricos del sistema
Técnicas para duplicar o hacer copias de seguridad de archivos y
documentos

23. Pie de foto.
20Documentación | Elaboración de una propuesta de desarrollo de proyecto
Guía general del sistema
Los detalles del sistema en términos que el cliente pueda
entender.
La configuración del hardware y software del sistema.
La filosofía detrás de la construcción del sistema.
Proporcionar referencias cruzadas

24. Pie de foto.
21Documentación | Elaboración de una propuesta de desarrollo de proyecto
Tutoriales y descripciones generales automatizadas
Tutoriales automatizados basados en multimedia, paso a paso

25. Pie de foto.
22Documentación | Elaboración de una propuesta de desarrollo de proyecto
Otra documentación: guía del programador
Una descripción general de cómo se configuran el software y el
hardware
Componentes de software detallados y sus funciones realizadas
Funciones de soporte del sistema
Mejoras del sistema

26. Pie de foto.
23Documentación | Elaboración de una propuesta de desarrollo de proyecto
Ayuda al usuario y solución de
problemas
Guía de referencia del mensaje de falla
Archivos de ayuda en línea
Guía de referencia rápida (un resumen
rápido de usos principales, configuración)

27. Pie de foto.
24Documentación | Elaboración de una propuesta de desarrollo de proyecto
Pautas para mensajes de falla
El nombre del componente de código que se ejecuta cuando ocurrió
la falla
El número de línea del código fuente en el componente que se
estaba ejecutando
La gravedad de la falla y su impacto en el sistema.
El contenido de cualquier memoria relevante del sistema o punteros
de datos, como registros o punteros de pila
La naturaleza de la falla, o un número de mensaje de falla (para
referencia cruzada con la guía de referencia de mensajes de falla)

28. Pie de foto.
25Documentación | Elaboración de una propuesta de desarrollo de proyecto
La capacitación y la documentación deben planificarse y
rastrearse desde el comienzo del proyecto.
El software de capacitación y documentación debe integrarse
con el software normal del sistema.
Todos los módulos y documentos de capacitación y
documentación deben tener en cuenta las diferentes
necesidades de diferentes audiencias.
Considera

29. Bibliografía recomendada
• Ingeniería de Software Orientado a Objetos. Bruegge, Bernd y
Dutoit, Allen. Prentice-Hall, 2002
• IEEE Recommended Practice for Software Requirements
Specifications Software Engineering Standards Committee of the
IEEE Computer Society. ISBN 0-7381-0332-2
• Ingeniería del Software. Un enfoque práctico. 7ma. Edición.
Pressman, Roger. McGraw-Hill, 2010
• Ingeniería de Software. 6ta. Edición. Sommerville, Ian. Prentice-
Hall, 2002
• Sistemas de información gerencial. Laudon & Laudon. Pearson,
2012.
• Ingeniería del Software. Un enfoque desde la guía SWEBOK.
Sánchez, Sicilia & Rodríguez. Alfaomega.
26
Bibliografía|Elaboración de una propuesta de desarrollo de proyecto
Concepto de biblioteca en línea con dispositivos electrónicos de lectura de personas y estantes de libros isométricos 3d . https://www.freepik.es/fotos-vectores-gratis/tecnología. Creado por
macrovector.

30. Sitios Web 27
Anexo| Elaboración de una propuesta de desarrollo de proyecto
Ilustración de personajes y concepto de www. https://www.freepik.es/fotos-vectores-gratis/tecnología. Creado por rawpixel.com
¿Cómo elaborar un buen manual de
usuario?
https://medium.com/grupo-
carricay/c%C3%B3mo-escribir-un-buen-
manual-de-usuario-fd8d0c6bae49

31. Gracias.
©2020
Es responsabilidad exclusiva de los autores el respeto de los derechos de autor sobre los contenidos e imágenes en el presente
documento, en consecuencia, la BUAP no se hace responsable por el uso no autorizado, errores, omisiones o manipulaciones de los
derechos de autor y estos serán atribuidos directamente al Responsable de Contenidos, así como los efectos legales y éticos
correspondientes.