Manual tecnico y Manual de usuario - Ingenieria del software

Summary

El video ofrece una introducción al manual técnico y de usuario para proyectos de software, enfocados en carreras de ingeniería. Cubre desde la portada y objetivos hasta la descripción de requisitos técnicos y de hardware. Detalla los pasos de instalación y configuración, así como la importancia de incluir diagramas y análisis previos al desarrollo. Además, explica cómo documentar funciones y proporcionar información adicional para facilitar la comprensión del usuario final.

Takeaways

• 😀 El manual técnico es esencial para las carreras de ingeniería en computación e informática.
• 📖 Se describe que el documento debe ser aplicado para una aplicación web de consola ya desarrollada.
• 🎯 Los objetivos del manual son inicialmente generales y luego específicos, detallando el alcance para el usuario o programador.
• 🛠️ Los requerimientos técnicos incluyen aplicaciones y herramientas necesarias para desarrollar el software, como un navegador, sistema gestor de base de datos y emulador de servidor.
• 💻 Los requerimientos de hardware específicos mencionan un mínimo de Intel inside, 512MB de RAM y 64GB de disco duro.
• 💾 Los requerimientos de software detallan sistemas operativos compatibles, como Windows XP, y mencionan que pueden variar.
• 🔧 La sección de instalación explica paso a paso cómo instalar la aplicación con capturas de pantalla, destacando la ejecución de un emulador de servidor y descomprimir el paquete de la aplicación.
• 🛠️ Se menciona la necesidad de incluir herramientas utilizadas para desarrollar el software, como XAMPP y Dreamweaver.
• 🔍 En el análisis se incluyen documentos de levantamiento de datos, especificación de requerimientos, gráficas de Gantt y PERT.
• 🏗️ El diseño de la arquitectura es extenso y requiere la inserción de diagramas y modelos previamente elaborados, como diagramas de bloques, diccionario de clases, tarjetas CRC, y diagramas de clases y objetos.
• 🔧 El plan de mantenimiento y los privilegios de usuario son discutidos, con énfasis en la gestión única de la aplicación y la base de datos.

Q & A

¿Para qué tipo de carreras está diseñado el manual técnico mencionado en el guion?

El manual técnico está diseñado para carreras de ingeniería en computación e ingeniería informática.

¿Qué se debe tener antes de tener el documento del manual técnico según el guion?

Se debe tener una aplicación web de consola ya desarrollada antes de tener el documento del manual técnico.

¿Cuáles son los objetivos generales y específicos que se describen en el manual técnico?

Los objetivos generales son proporcionar una vista general del documento, mientras que los objetivos específicos son un listado detallado del alcance para el usuario o programador que maneja el manual o programa.

¿Qué tipo de requerimientos técnicos se mencionan en el guion para desarrollar el software?

Se mencionan requerimientos de hardware, como un procesador Intel con pocos gigahercios de velocidad, 512 MB de memoria RAM y 64 GB de disco duro, y requerimientos de software como un sistema operativo Windows XP.

¿Cómo se describen los pasos de instalación en el manual técnico?

Los pasos de instalación se describen con instrucciones seguidas de capturas de pantalla para facilitar la comprensión, incluyendo la ejecución de un emulador de servidor y la descomprension de paquetes.

¿Qué herramientas se utilizan para desarrollar el software según lo mencionado en el guion?

Se utilizan herramientas como un gestor de base de datos, un emulador de servidor, un entorno de desarrollo para páginas web y XAMP.

¿Qué se debe incluir en la sección de configuración del manual técnico?

Se debe incluir si la aplicación viene preconfigurada y, en caso contrario, los pasos necesarios para configurarla.

¿Qué tipo de documentos se deben insertar en la sección de análisis del manual técnico?

Se deben insertar documentos como propuestas de entrevistas, calendarios para entrevistas, la Gráfica de Gant y la Gráfica de PERT.

¿Qué contenido debe incluirse en la sección de diseño de la arquitectura del manual técnico?

Debe incluirse el diagrama de bloques, diccionario de clases, tarjetas CRC, diagrama de clases, diagrama de objetos, diagrama de casos de uso, definición de casos de uso, identificación de actores y diagrama de secuencias.

¿Qué se debe incluir en el plan de mantenimiento del manual técnico?

Se debe incluir todo el código fuente que se utilizó para el funcionamiento de la aplicación, organizado de manera que se pueda entender qué módulo se está describiendo.

¿Cómo se aborda la sección de privilegios de usuario en el manual técnico?

Se describe si la aplicación requiere un administrador exclusivo para la base de datos o si un solo usuario puede manejar tanto el programa como la base de datos.

Outlines

00:00

😀 Introducción al Manual Técnico

El primer párrafo introduce el manual técnico, específicamente diseñado para carreras de ingeniería en computación e informática. Se menciona que el documento está asociado con una aplicación web de consola ya desarrollada. Se describen los objetivos generales y específicos del manual, así como los requerimientos técnicos necesarios para el desarrollo del software, incluyendo herramientas y sistemas operativos específicos. Se habla de los requerimientos de hardware y software, y se detalla el proceso de instalación con capturas de pantalla para facilitar la comprensión.

05:01

🔧 Requisitos y Herramientas de Desarrollo

Este párrafo se centra en los requerimientos de instalación y las herramientas utilizadas para el desarrollo del software. Se discute la configuración de la aplicación, la etapa de análisis con la inclusión de documentos como levantamiento de datos y especificaciones de requerimientos. Se mencionan gráficas de Gantt y PERT, así como la importancia de comprender el propósito y el alcance del documento. Se enfatiza la necesidad de insertar diagramas y especificaciones de diseño, y se describe el proceso de desarrollo detalladamente, incluyendo la inclusión del código fuente y la estructura de la documentación.

10:01

👤 Privilegios de Usuario y Finalización del Manual

El tercer párrafo trata sobre la configuración de privilegios de usuario y la finalización del manual técnico. Se menciona la decisión de tener un único tipo de usuario para administrar tanto el programa como la base de datos, en lugar de separar los roles de administrador y usuario. Se concluye con una mención a los cinco puntos principales que deben incluirse en el manual: análisis, diseño, desarrollo, propuestas de actividades y privilegios de usuario. El presentador, Luis Carlos Velasco, invita a la audiencia a revisar el video y a participar en la comunidad.

15:01

📚 Manual de Usuario: Importancia y Contenido

El cuarto párrafo introduce el concepto del manual de usuario y su importancia para la satisfacción del cliente y la recomendación del producto. Se describen los elementos básicos que deben incluirse en un manual de usuario, como la descripción general del software, los objetivos, las funciones y los requerimientos específicos. Se enfatiza la necesidad de usar un lenguaje claro y accesible para los usuarios finales, evitando tecnicismos y proporcionando instrucciones detalladas para la instalación y la configuración del software.

20:02

🛠 Procedimientos de Instalación y Funcionalidades

Este párrafo se centra en los procedimientos de instalación y las funcionalidades del software, con énfasis en la claridad y simplicidad del lenguaje para facilitar la comprensión al usuario. Se describen los pasos detallados para la instalación, la configuración y el uso de las funciones del software. Se sugiere la inclusión de capturas de pantalla y la creación de un glosario para aclarar cualquier tecnicismo que pueda ser necesario. El presentador finaliza con una invitación a los asistentes a aplicar estos conceptos para crear un manual de usuario efectivo.

Keywords

💡Manual técnico

Un manual técnico es un documento que proporciona información detallada sobre cómo funcionan los sistemas, la instalación, la configuración y el mantenimiento de un producto o software. En el vídeo, el manual técnico se refiere específicamente a la documentación aplicada a carreras de ingeniería en computación e informática, y se utiliza para describir los requerimientos, la instalación y la configuración de una aplicación web, entre otros aspectos.

💡Requerimientos técnicos

Los requerimientos técnicos son los estándares y especificaciones que un producto o sistema debe cumplir para funcionar correctamente. En el contexto del vídeo, se mencionan requerimientos tanto de hardware como de software, como un procesador Intel de cierta velocidad, una cantidad mínima de memoria RAM y un sistema operativo específico, para asegurar que la aplicación funcione adecuadamente.

💡Instalación

La instalación hace referencia al proceso de configurar y poner en marcha un software o hardware en un sistema. En el vídeo, se describen los pasos de instalación de una aplicación web, incluyendo la ejecución de un emulador de servidor y la descomprension de paquetes, que son cruciales para que el programa funcione correctamente en un entorno local.

💡Configuración

La configuración es el proceso de ajustar los parámetros y opciones de un sistema para que se adapte a las necesidades específicas de un usuario o una organización. En el vídeo, se habla de la configuración de la aplicación web, que puede incluir la personalización de la interfaz de usuario o la definición de roles de usuario.

💡Análisis

El análisis es el proceso de examinar y evaluar los datos o la información para comprender mejor un problema o un sistema. En el vídeo, se sugiere que el análisis se documenta en el manual técnico, incluyendo la documentación de los levantamientos de datos y la especificación de requerimientos, que son fundamentales para el diseño y desarrollo del software.

💡Diseño

El diseño en ingeniería de software se refiere al proceso de planificar y estructurar una solución antes de la implementación. En el vídeo, se menciona que el diseño incluye la creación de diagramas como los de bloques, diccionario de clases, tarjetas CRC, diagramas de clases, objetos y casos de uso, que son esenciales para guiar el desarrollo del software.

💡Desarrollo

El desarrollo es el proceso de crear o construir un producto o sistema a partir de los diseños y especificaciones. En el vídeo, el desarrollo se refiere a la codificación y programación necesarias para dar vida a la aplicación, incluyendo el código fuente que se documenta en el manual técnico para futuras referencias y mantenimiento.

💡Mantenimiento

El mantenimiento es el proceso de conservar y mejorar un sistema o producto para que siga funcionando de manera eficiente. Aunque no se menciona directamente en el vídeo, el mantenimiento es un aspecto crucial que se aborda en los manuales técnicos, ya que proporciona instrucciones sobre cómo actualizar y reparar el software.

💡Manual de usuario

Un manual de usuario es un documento que proporciona instrucciones sobre cómo utilizar un producto o servicio. En el vídeo, se describe cómo crear un manual de usuario que explique claramente las funciones y la instalación del software, con el objetivo de garantizar una mejor experiencia y satisfacción del cliente.

💡Glosario

Un glosario es una lista de términos especializados y sus definiciones, que se utiliza para ayudar a los usuarios a comprender el vocabulario técnico asociado con un producto o tema específico. En el vídeo, se sugiere incluir un glosario en el manual de usuario para definir términos técnicos que puedan no ser familiares para el usuario promedio.

Highlights

Presenta el documento del manual técnico aplicado para carreras de ingeniería en computación e informática.

El manual es necesario para desarrollar una aplicación web de consola previamente creada.

El índice del manual proporciona una visión general y específica del contenido.

Se describen los objetivos generales y específicos del manual, incluyendo el alcance y el público objetivo.

Se detallan los requerimientos técnicos, incluyendo aplicaciones y herramientas necesarias para el desarrollo del software.

Se especifican los requerimientos de hardware mínimos necesarios para ejecutar la aplicación.

Se mencionan los requerimientos de software, como el sistema operativo Windows XP mínimo requerido.

Se explican los pasos de instalación con capturas de pantalla para facilitar la comprensión.

Se discuten los requerimientos de herramientas utilizadas para desarrollar el software.

Se describe la configuración de la aplicación, si es preconfigurada o no.

Se detallan los documentos de análisis, como levantamiento de datos y especificación de requerimientos.

Se presentan los diagramas de diseño, como diagramas de bloques, clases, objetos, casos de uso y secuencias.

Se discute el plan de mantenimiento de la aplicación.

Se explica el desarrollo, incluyendo el código fuente y su importancia para los programadores.

Se mencionan los privilegios de usuario, si la aplicación requiere de un administrador o puede ser manejada por un usuario normal.

Se concluye que el manual técnico consta de análisis, diseño, desarrollo, propuestas de actividades, objetivos y privilegios de usuario.

Se introduce el manual de usuario y su importancia para la satisfacción del cliente.

Se describe la estructura del manual de usuario, incluyendo la descripción, requisitos y procedimientos de instalación.

Se explica cómo se deben describir las funciones del software de manera accesible para el usuario final.

Se sugiere agregar una sección de información adicional o glosario para facilitar la comprensión técnica.

Transcripts

muy buenas noches amigos y suscriptores

de YouTube cómo han

estado esta noche Les traigo nada más y

nada menos que el documento del manual

técnico dicho documento está aplicado

Solamente para las carreras de

ingeniería en computación e ingeniería

informática muy bien Vamos a empezar a

describirlo de entrada podemos ver que

tenemos una portada seguido de eso

tendríamos el logotipo de dicho dicha

aplicación en la que vamos a desarrollar

ojo esto quiere decir que para tener

este documento ya se tendría que tener

una aplicación web de consola ya saben

de lo que hablo ya desarrollada muy bien

su índice y pasamos a la zona de

explicar los

objetivos muy bien los objetivos de

entrada hacen constatar de que se va a

tratar el documento los primeros

objetivos solamente es una vista general

de dicho documento y los que siguen los

específicos como su nombre lo indica

tiene que ser un

listado el alcance para todas

las el usuario o vaya el programador que

va a manejar dicho manual técnico o este

o el programa en este

caso en los requerimientos técnicos

fueron los requerimientos o más bien las

aplicaciones o todo aquello que se

necesitó para poder desarrollar

dicho dicho software bueno en este caso

como ven en este ejemplo como de una

aplicación web fue de un navegador un

sistema gestor de base de datos un

emulador de un ampli de un servidor que

en este caso es samp eso es de lo que

posiblemente trataría de lo que trata

este

requerimiento ya siendo un poco más

específico estamos con los

requerimientos de Hardware en este caso

lo lo que yo testé y lo que yo examiné

que esta aplicación podía cumplir fue

para un Intel

inside de pocos gigahercios de velocidad

con poca memoria RAM 512 y 64 GB de

disco duro fue el mínimo al menos lo que

yo pude calcular de que podía correr

dicha

aplicación perdón

muy bien seguimos con los requerimientos

de software bueno en este caso si se van

a si se dan cuenta como lo hice aquí se

ocuparía como mínimo un Windows XP que

fue el mismo sistema operativo en la en

la cual lo esta aplicación fue

corrida hago hago mención de que dicha

aplicación puede puede que a lo mejor

varie pero esto es solamente ejemplo o

sea su su aplicación viene distinta

claro los requerimientos de todo este

documento pueden cambiar de alguna forma

ustedes ya deciden si agregar más o

no muy bien bueno en este caso

sigue sigue los requerimientos

de Ah perdón el punto de instalación Sí

en el punto de instalación como su

nombre lo indica aquí es todos los pasos

junto con capturas de pantallas todos de

alguna manera con la que sea más más

entendible posible se explique cómo va a

ser instalada esta aplicación en este

caso como podemos ver es primero regla o

primero instrucción y luego captura de

pantalla en este caso como es un

aplicación web Y contiene un código

fuente lo que tienes que hacer primero

es correr tu emulador de servidor en

este caso el samp después de eso

eh descomprimir dicho paquete o ejecutar

el paquete que tú tengas donde tú tengas

todas tus aplicaciones abrir tu

explorador y de ahí en más este hacer

hacer lo que bueno ya todo todo

programador sabe hacer pruebas de testeo

meter datos etcétera etcétera todo bueno

es eso puede ser descrito en esa parte

de de instalación

un paso que me he olvidado mencionar ha

sido los requerimientos o bueno más bien

este caso los los programas o todas las

herramientas que se utilizaron para

poder desarrollar dicho software en este

caso como ya había mencionado es un

punto muy parecido al otro que se

utilizó un gestor

eh el emulador de de servidor el este

caso xamp el mismo entorno de desarrollo

la aplicación de entorno de desarrollo

que es el Dream weer para para páginas

web en en este caso Claro en cuyo caso

en el que ustedes hagan va a ser de una

Puede que sea x o y muy bien llegamos a

la etapa del

configuración en este caso la

configuración por su mismo nombre lo

dice es si esta aplicación x va a llevar

una

preconfigurado en cuyo caso a veces

puede ser y a veces no seguido de esto

sigue la etapa de análisis en el en este

documento el análisis se maneja

múltiples múltiples documentos por en

este

caso los documentos a poner en este

requerimiento son los de los

levantamiento de datos y la

especificación de requerimientos a qué

me refiero con estos es que se va a

insertar se va a insertar

eh las propuestas de entrevistas los

calendarios para para hacer esas

entrevistas la Gráfica de gant y la

Gráfica de pert esos documentos que se

hicieron prediseño antes de poder

desarrollar tu aplicación serán

insertados aquí todo todo absolutamente

todo claro siendo más específicos son

los diagramas que había dicho

anteriormente eh algo aquí es que si no

se sabe qué es lo que Qué es para qué

aplicación pues va a tener este

documento es mejor no seguir adelante

con el vídeo porque va a haber

vocabulario que a lo mejor es poco

probable que la gente o si no eres de la

carrera no se pueda comprender muy bien

sigue sigue lo que

es bueno vemos aquí las gráficas de gant

y de pert sigue nada más y nada menos

que el diseño de la arquitectura aquí en

el diseño de la arquitectura este

posiblemente es el requerimiento más

largo por qué Porque es el imento más

largo

eh Bueno es porque aquí al al igual que

en el anterior requerimiento se

necesitará de insertar los todos todos

todos absolutamente todos eh los

trabajos que se han hecho con

anterioridad con respecto al diseño a

qué me refiero con esto para ser más

específico al diagrama de bloques

diccionario de clases tarjetas crc

diagrama de clases diagrama de objetos

diagrama de casos de uso definición de

casos de uso identificación de actores

diagrama de secuencias todo

absolutamente todas las todas las

actividades que se tuvieron que hacer

con anterioridad al desarrollo de tu

aplicación deben de ser insertadas aquí

ojo son las de diseño no estoy hablando

No estoy hablando del Análisis el

análisis ya fue el anterior al diseño sí

hay que dejar muy en claro esto y bueno

como podemos ver aquí están lo que estos

todo todo lo que es tarjetas rc diagrama

de clases de objetos de secuencia todo

eso aquí podemos ver ejemplos de

ello más y más ejemplos bueno ojo esos

diagramas es solamente para para

ejemplificar lo que ustedes deberían de

poner en su caso deberían de poner algo

o las actividades previas a las que

ustedes debieron de lo que ustedes

debieron de haber hecho antes de

programar el plan de

mantenimiento Y

bueno llegamos a la parte del desarrollo

este este punto al igual que el otro que

el anterior es algo extenso porque aquí

ya viene todo el código fuente que se

ocupó o que más bien Quedó hecho o

programado para que su aplicación tenga

funcionamiento bueno empezamos podemos

ver aquí ejemplo de código tienen que no

es necesario pues escribirlo s sé que

muchos aplicarían la de Bueno dejal lo

escribo pero no en este caso podemos

tomar un atajo y copiar y pegar Pues que

es por lo regular lo que se hace Pero

bueno siendo un poco más en claro en

esta parte de desarrollo se tiene que

poner todo absolutamente todo todo el

código fuente que tiene tu aplicación

absolutamente todo puedes ir

señalándolas con unos pequeños títulos

grandes para ir diciendo qué módulo es

el que vas poniendo para que no n más se

vean letras y todo es por eso que antes

en los primeros puntos en los primeros

requerimientos decía que este manual

técnico iba más que nada orientado para

los

programadores por lo mismo de que haber

código fuente y vocabulario muy poco

comprensible a usuarios normales Y bueno

ya llegando al último punto de

privilegios de usuario aquí a lo que me

refería que también tiene relación con

lo otro es checar

eh poner ponerte a pensar a futuro si tú

vas a necesitar esta aplicación

solamente para manejo de usuario normal

un usuario una persona normal o vas a

tener también relación directa con la

base de datos todos sabemos que cuando

tú vas a tener una base de datos

necesitas un administrador exclusivo

para esa base de datos pero en este caso

para el en la entrevista en la propuesta

de entrevista se le fue preguntado al

gerente si iba a necesitar dos tipos de

personas uno que lo administre y otro

que manejar el programa y se dijo que no

que uno solo entonces en este caso los

privilegios de usuario iban a ser

totales o sea una sola persona iba a

manejar dicho dicho programa junto con

su base de

datos y bueno con esto podríamos decir

que ya hemos terminado la explicación de

todo nuestro manual técnico pueden

revisarlo chequen este video si no quedó

claro pero a lo que podemos concluir es

que va a constar de cinco de cinco

puntos

los análisis el diseño el desarrollo

todas las propuestas de actividades

objetivos y al final solamente los

privilegios Bueno creo que fueron más de

cinco pero bueno bueno creo que esto ha

sido todo amigos Espero que les haya

gustado mucho el víde denle like

suscríbanse y si quieren por favor

pueden compartirlo para que nuestra

comunidad siga creciendo Muchas gracias

Aquí Luis Carlos Velasco fuera

Hola muy buenas Este es un tutorial

sobre el manual de usuario para empezar

Qué es un manual de usuario un manual de

usuario es donde explicas a tu usuario

final Cómo es que debe de usar tu

proyecto tu maquinaria etcétera etcétera

etcétera qué tan importante es este

documento Bueno en realidad es muy

importante saber hacer un manual de

usuario ya que en él explicas a tu

usuario final a tu cliente que cómo es

que debe usar tu programa Y cómo debe

instalarlo esto para lograr una mejor

satisfacción en tu producto y que el

cliente pueda recomendarte Esto es

beneficioso para ti así que de es muy

importante que sepas usar ya vas de

hacer bien este manual bueno para

empezar Aquí vemos dos

planillas materia ingeniería de software

Universidad de Guadalajara Centro

Universitario Esta es una

planilla aquí

en el proyecto irá lo que es tu nombre

del proyecto y la revisión porque puede

haber muchas revisiones puede haber una

dos

20 en este caso en el lado izquierdo

tenemos la revisión uno o sea es el

primer manual de usuario que se

hace bueno continuamos esta plantilla la

estaré usando para ir

explicando aquí por ejemplo en la

cabecera podemos poner un logo en

nuestro plantilla

también el nombre del proyecto y la

página a la que hace

referencia aquí como pueden ver tengo mi

logo mi manual de usuario y mi

página aquí debe deir su

logo logo de la

empresa debe de ir en manual de usuario

nombre del proyecto

el

índice aquí yo lo

tengo aquí está todos mis

módulos

y Bueno aquí

empezamos con la descripción Qué debe ir

en la descripción bueno como aquí dice

el contenido de este apartado debe

expresar una pequeña explicación general

sobre el software además de un pequeño

listado de las funciones que se puede

realizar con el

mismo en teoría debes de explicar lo que

hace tu sistema debes de decir a quién

va dirigido eh Qué funcionalidad

tiene este Cuáles sí etcétera sus

objetivos y de lo que debe de realizar

el software aquí dice este sistema

básicamente se encargar de administrar

información de los sinemas de la Laguna

est información va desde la venta de

boletos la administración de cada sala y

película venta de tarjetas vib etcétera

etcétera etcétera aquí estoy explicando

mis lo que va a ser mi sistema lo que va

a gestionar la formación etcétera

etcétera

etcétera

requerimientos Bueno aquí debes de Por

ejemplo si fuera algún Hardware o

software especial en este caso es solo

un sistema web no ocupa tantos

requerimientos pero por ejemplo tu

sistema o algún Hardware especial

necesitas especificar las versiones con

las que comp ese sistema operativo y De

cuántos bits Linux Windows Mac

etcétera aquí por ejemplo no más en este

sistema web yo estoy especificando un

buen Rango considero yo de sistemas

operativos y y de de arquitecturas de 34

y 64 de 32 y 64

bits Bueno aquí vamos narrando lo que es

la

instalación también otra vez el si fuera

un software pesado si fuera de para

máquina para terminales O sea que no

fuera estar en la nube debes de explicar

paso a paso la instalación Y si ocupas

algún tipo de software especial para

montar eh Por ejemplo en este caso un

sistema web nosotros ocupamos un

servidor especial para montar un

servidor para poder hacer para poder

este montar lo que es nuestro sistema

web en la nube mientras hacemos las

pruebas ya después ocuparemos algún

Hosting que nos del el que nos que que

ocupe nuestro sistema para poder ser

visualizado en la nube etcétera etcétera

etcétera Bueno aquí pues van van

describiendo cada paso y Pon una captura

de pantalla este punto es importante ya

que aquí debes de ser fluido y debes de

eh hacer de explicar un lenguaje natural

ya que

las ya que las los tus clientes no

entienden nada de tecnicismos debes de

hacerlo más específicos recuerda tú como

desarrollador o como experto en

tecnologías

tú has de pensar que pues es algo

ilógico pues andar explicando eso pero

recuerda que no todos saben tus

conocimientos Entonces por favor trata

de narrar de una manera en que alguien

que no sepa nada de tecnología pueda

Ender lo que estás

haciendo Entonces aquí se van

escribiendo los pasos paso a paso

B de

pantalla Ven aquí Aquí estoy yo por

ejemplo para montar lo que es mi

servidor

local paso B bla bla

bla Aquí vamos viendo có es En dónde lo

debe de guardar etcétera aquí por

ejemplo pues si fuera una instalación de

algún programa que se va a instalar en

el la la raíz del en el disco duro ya

vas explicando exactamente En dónde se

va a instalar qué es lo que hay que

hacer y aquí por ejemplo montel el one

server que debe de estar en color verde

para poder ya montar

tu tu una un sistema web en o alguna

página web en local Host acceder un

navegador

y mostrando cómo queda montada mi de

esta mi sistema web Bueno aquí en

configuración Por ejemplo yo no aquí no

aplica para el sistema web pero dice que

algunos software ocuparán dependencias O

sea a lo mejor tu sistema ocupará

algunas

dependencias no sé algunas librerías

especiales algún Hardware especial eh

este Bueno hay algunos que ocupan otros

que no ocupan Aquí vamos explicando la

descripción de de nuestro de la

configuración inicial Cuál es su

finalidad para que nos va a ayudar a

nuestro a nuestra software O desarrollo

que ya hamos hecho una captura de

pantalla capturas de pantalla igual lo

mismo descripción finalidad siempre

tratando de con un lenguaje natural de

explicarle al usuario Cómo es que se

hacen las cosas no hables con

tecnicismos es preferente que no hablar

con

tecnicismos

Bueno aquí en funciones debemos deistar

todas nuestras todos nuestros funciones

de software o sea esto se refiere a que

debes de enlistar cada una cada una de

tus funcionalidades de tu sistema esto

quiere decir que si por ejemplo para

calcular para calcular un promedio de

algunos estudiantes de sus

calificaciones del año tú debes de sacar

el ocupas una función promedio entonces

tú debes de describir esa función de esa

función promedio por más mínima que sea

tú debes de explicar al cliente al

usuario Cómo es que va a funcionar tu

programa entonces cada funcionalidad que

con el que interactúe el usuario debes

de explicárselas debes de de ser debes

de enlistar todas tus

funciones y necesitas como ya vengo

repitiendo necesitas decirlo en un

lenguaje eh natural que no que no tenga

con tecnicismos evitando la mayor posib

mayor cantidad de tecnicismos que sea

posible entonces viendo una vez esto si

tenemos 50 funciones esas 50 funciones

las debes de narrar debes de explicarlas

a tu cli a tu usuario fin Cómo es que

debes de cómo es que se deben de de cómo

es que funcionan

Perdón Aquí vamos viendo la finalidad y

descripción de la función O sea que qué

fin tiene para que para qué ayuda qué

resultados va a mandar qué es lo que qué

es lo que que espera qué es lo que va a

poder visualizar o cuál es el resultado

que va a poder ver el usuario final y

los pasos para realizar esta función o

sea A dónde a qué módulo te debes A qué

apartado te debes entrar eh Qué datos

debe de de contener si por ejemplo es

algún capturar o o por ejemplo

Eh Pues sí si ocupara requerimientos

especiales que debes de narrar también

los pasos para llegar a esa función aquí

como podemos observar yo voy explicando

que primero debes de entrar a la página

inicial de administrador luego cliquear

en donde dice nueva

película aparecerá la siguiente ventana

aquí y Lu ingresamos

datos clicamos en capturar nos mandará

esta

formulo que ocupamos presionar regresar

para volver al módulo de capturar alguna

película y cliquear en regresar en el

mismo módulo para volver al índice

inicial básicamente Esos son los pasos

que debes de se debe de seguir es un

módulo muy

sencillo pero tú debes de por ejemplo

intentar si tienes un módulo muy grande

eh da igual tienes que intentar

explicarlo y debes de paso por paso y su

finalidad los resultados que se esperan

etcétera igual para la función

B función c función d yo por ejemp

ejemplo saqué cuatro funcionalidades ya

que como digo Solo estoy mostrando un

ejemplo de cómo es de que debería de

quedar un manual de

usuario básicamente a veces los los

módulos son repetitivos no más es copiar

y pegar por eso no tenga mucho

inconveniente

ven modificar eliminar voy a

explicando así se va explicando

y bueno para concluir la información

adicional tú debes de

Añadir

información que le pueda facilitar al

cliente la lectura de tu manual de

usuario Por ejemplo si llegaste si fue

muy necesario usar algún tecnicismo este

si entraste en algo técnico o algo así

tú por ejemplo podrías aquí armar un

glosario en el que le vas explicando Ah

pues ahora sí en lenguaje natural Ah

pues por ejemplo un tester es la persona

encargada de de probar algún sistema

para ver que esté funcionando

correctamente y encontrar algún tipo de

error esa sería una descripción de

tester entonces tú por ejemplo debes de

Añadir

información que le pueda facilitar la

lectura a ese

cliente Sí y bueno esto sería todo del

manual de usuario

espero que haya podido ser claro y

conciso en lo que quería

explicar Muchas gracias