TRABAJO DE

INVESTIGACIÓN
GESTIONA INFORMACIÓN A TRAVES DE
PLATAFORMAS DIGITALES

DOCENTE: SOTO ARREOLA ISABEL

REALIZADO POR: CRUZ GARCÍA DIANA EMILY

CENTRO BACHILLERATO
TECNOLOGICO INDUSTRIAL Y DE
SERVICIOS N. 78
INTRODUCCIÓN.

El presente trabajo de investigación es basado a los temas obtenidos en ----, donde principalmente
se enfocan en la normativa de un proyecto, y se desglosa contestando una variedad de preguntas
como; ¿Por qué es necesario documentar un Proyecto? De igual forma ¿Cómo documentar un
proyecto web? También ¿Qué requisitos debe cubrir la información que se reporta en el proyecto;
problema a resolver, requerimientos del cliente, integrantes del equipo de trabajo, tecnología a
utilizar, propuesta de marketing?, de igual forma se hablara sobre ¿Bajo que normativa se rige el
formato de documentación?

Al final del documento encontraran un pequeño y sencillo bosquejo sobre la estructura general de
nuestro proyecto.

Todo lo visto en esté trabajo nos llevara a un entendimiento más exacto hacia la importancia de la
documentación de un proyecto y su estructura, para de está manera contar con el conocimiento
requerido para realizar proyectos de calidad.

P á g i n a 1 | 10
DIANA EMILY CRUZ GARCÍA
DESARROLLO.

¿Por qué es necesario documentar un Proyecto?

Para comenzar, la documentación son los registros que una organización debe conservar para
fundamentar las decisiones o cambios que tiene y toma la empresa. Está documentación puede ser
en general, desde los documentos que se obtengan en la planificación hasta las políticas más
importantes, esto quiere decir que la documentación puede llegarse a ver infinita, pero al llevar
una buena organización, no se nos dificulta saberla manejar.

Para que un proyecto sea de calidad y se considere interesante, organizado y creíble, debe estar
fundamentado y está fundamentación se apoya en la documentación las cuales son importantes
para comenzar a edificar las piezas con las que obtendremos el servicio o producto demandado. Y
para que todo el proceso se realice de una manera correcta, es necesario que el proyecto sea
analizado y tenga una buena organización.

La documentación debería ser una prioridad por diversas cuestiones, sin embargo, en esté trabajo
solo se colocarán algunas de las más importantes:

1. Contar con una fuente de información confiable nos hace ahorrar tiempo y reducir energía:
Esto lo fundamentamos al ver el escenario de un trabajador en busca de información pierde
tiempo el cual es valioso en su trabajo. En cambio, si el trabajador cuenta con una
documentación ordenada, hace una búsqueda en menor cantidad de tiempo y hace de su
trabajo más eficaz y eficiente.
2. Ayuda a tener un control de calidad y de los procesos: La documentación fomenta el
intercambio de conocimientos, lo que capacita a los trabajadores para saber como
funcionan los procesos y como suelen ser los proyectos y acciones en la empresa.
3. Evita que se dupliquen los proyectos: Al tener una documentación contamos con la
información de os proyectos anteriormente realizados y esto ayuda a tomar decisiones
sobre nuevos proyectos los cuales se basen en acciones anteriormente no realizadas e
innovadoras.
4. Facilita la conformación e incorporación: Si se pone como prioridad la documentación, se
tendrán todo tipo de guías, instrucciones y notas útiles que podrán consultar a medida que
se vayan poniendo al día en sus nuevas funciones los nuevos integrantes en una empresa.

P á g i n a 2 | 10
DIANA EMILY CRUZ GARCÍA
 Además, pueden utilizar esos recursos para encontrar respuesta a sus preguntas y empezar
a averiguar cosas por su cuenta, en vez de sentir que tienen que contactar con alguien de tu
equipo a cada duda o escollo que les surja.

¿Cómo documentar un proyecto web?

El objetivo de escribir la Documentación de un Sitio Web es describir, detalladamente, todos los

aspectos relacionados con un Proyecto Web, especialmente en lo que se refiere a su Diseño Web,
acciones de Marketing y Monetización. Por tanto, es un documento que deberá ser actualizado a
medida que el proyecto evolucione en el tiempo, o dicho de otro modo, mientras el Sitio Web esté
vivo.

1. Documentar lo básico.

Un problema muy común cuando solicitas ayuda, o cuando haces un onboarding a algún
compañero/a de equipo es que esa persona no tenga forma de levantar o hacer correr el proyecto
sin tener al menos algún tipo de problema por desconocimiento o falta de información. Por eso es
muy importante y es básico de cualquier proyecto que tenga documentado estas 3 características,
no existen excusas para que no lo hagas.

• Comandos para levantar o correr el proyecto

• Variables de entorno necesarias para establecer una configuración inicial o similar

• Preguntas frecuentes a problemas comunes.

2. Extender el detalle de la documentación.

Ya documentado lo básico, hay que pensar en los términos a mediano y largo plazo (más de 4
meses). Cuando se empieza a trabajar en el proyecto y hay varios equipos involucrados en el
desarrollo (ej.: un equipo frontend y otro backend) es muy importante que ambos equipos estén
sincronizados, que conozcan como se está construyendo el software, entender y estar al tanto de
los datos que se transfieren de un equipo al otro, etc. Por eso considero que en este punto es
indispensable al menos documentar los siguientes tres puntos:
P á g i n a 3 | 10
DIANA EMILY CRUZ GARCÍA
 • Arquitectura del proyecto (front, back, infra) indicando quién es el responsable de cada
área o proceso. (Recomiendo documentarlo como un diagrama de flujo o similar)

• Contratos entre el backend y el frontend.

• Decisiones tecnológicas, librerías, frameworks y herramientas utilizadas.

3. Centralizar la información del cliente.

El último paso para comenzar a tener una documentación sólida es centralizar la información que
se obtiene del cliente en el proyecto. Una Wiki debería usarse como "la fuente de la verdad" un
lugar centralizado donde encontrar información útil para cualquier miembro del equipo.

• Accesos y credenciales a herramientas, VPN, etc.

• Datos de ambientes del cliente (ej.: servidores, plataformas, IPs, etc.)

• Material de seguimiento y seguridad (tracking IDs scripts para Google Analytics, Hotjar,
reCAPTCHA, etc.)

• Documentación visual de componentes (frontend) o tests de integracioens (backend)

Precauciones a tener en cuenta.

• La documentación es una herramienta viva, no hay que permitir que se desactualice.

Dedicarle tiempo al menos 1 vez cada dos semanas o cuando sea necesario.
• Documentar lo importante en archivos (ej.: README.md, CONTRIBUTION.md) así
pueden migrar junto con el proyecto y no quedan separados en una Wiki o similar.
• No asumir por entendido lo que nos parece obvio ya que no tenemos los mismos seniorities
ni pertenecemos a las mismas áreas.

¿Qué requisitos debe cubrir la información que se reporta en el proyecto?

La recopilación de requisitos es el proceso que consiste en identificar las necesidades exactas de

tu proyecto de principio a fin. Este proceso se realiza durante la fase inicial del proyecto, pero se
extiende a lo largo de la duración del mismo.
P á g i n a 4 | 10
DIANA EMILY CRUZ GARCÍA
La recopilación de requisitos suele llevarse a cabo durante el brief del proyecto o la reunión
inicial.
Algunas de las preguntas que debes hacer son las siguientes:
• ¿Cuánto tiempo durará el proyecto?
• ¿Quién participará en el proyecto?
• ¿Cuáles son los riesgos potenciales de este proyecto?
La recopilación de requisitos no debería ser compleja, aunque es un componente importante de
cualquier plan de proyecto.
Paso 1: Asigna los roles
El primer paso en la recopilación de requisitos es la asignación de roles en tu proyecto. Aquí
debes identificar a los participantes del proyecto.
Los participantes o partes interesadas son aquellas personas involucradas en el proyecto, ya sean
socios internos o externos.
Paso 2: Reúnete con las partes interesadas
Luego de que hayas identificado a las partes interesadas del proyecto, reúnete con ellos para
tener una idea clara de lo que esperan obtener del proyecto. Es muy importante poder
comprender sus expectativas ya que, en definitiva, tus entregables estarán destinados a ellos.
Algunas preguntas que puedes hacer son las siguientes:
• ¿Cuál es tu objetivo para este proyecto?
• ¿Qué elementos o acciones crees que harían que el proyecto sea un éxito?
• ¿Qué cosas te preocupan de este proyecto?
• ¿Qué características te gustaría que tuviera este producto o servicio que aún no tiene?
• ¿Qué cambios recomendarías realizar a este proyecto?
Los participantes o partes interesadas son las personas para las que estarás desarrollando el
proyecto, por lo que es importante que puedas hacerles preguntas que te ayuden a crear tu lista de
requisitos.
Paso 3: Recopila y documenta la información
El paso tres del proceso ocurre al mismo tiempo que el paso dos. Recopilarás información a
medida que realizas las preguntas a los participantes. El objetivo es documentar tanta
información como puedas, para poder tener todas respuestas que necesitas para empezar tu
proyecto.
Información que se puede documentar:

P á g i n a 5 | 10
DIANA EMILY CRUZ GARCÍA
 • Respuestas de las partes interesadas a las preguntas de la entrevista
• Preguntas para las partes interesadas
• Solicitudes de las partes interesadas
• Comentarios de las partes interesadas
• Preguntas y comentarios que surgen durante las entrevistas
Paso 4: Enumera los requisitos y supuestos
Una vez que hayas completado el proceso de solicitudes, usa la información que has recopilado
para crear el plan de gestión de requisitos.
Paso 5: Obtén la aprobación
Una vez que hayas formalizado los requisitos de tu proyecto, necesitarás obtener la aprobación
de las partes interesadas para asegurarte de satisfacer las necesidades de los usuarios. Fomentar
una comunicación clara también puede ayudar a evitar que ocurran corrupciones en el alcance ya
que te aseguras de que las partes interesadas conozcan los límites del proyecto desde el principio.
Luego, puedes desarrollar el plan de implementación, en el que puedes incluir la adquisición de
los recursos y la creación de un equipo.
Paso 6: Supervisa el progreso
La última etapa del proceso es supervisar el progreso de tu proyecto. Puedes usar un software de
gestión de proyectos para dar seguimiento al presupuesto del proyecto y a otros requisitos a
medida que avanzas en la ejecución del proyecto. El beneficio del software de gestión de
proyectos es que puedes visualizar los cambios en tu proyecto en tiempo real y actuar de
inmediato cuando algo salga mal.

Normativa APA.
Las normas APA son estándares creados por la American Psychological Association, con el fin de
unificar la forma de presentación de trabajos escritos a nivel internacional, diseñadas
especialmente para proyectos de grado o cualquier tipo de documentos de investigación.
Formato de los trabajos:
• Tipo de letra: Times New Roman
• Tamaño de letra: 12
• Interlineado: a doble espacio (2,0), para todo el texto con única excepción en las notas a
pie de página
• Márgenes: 2,54 cm por todos los lados de la hoja
• Sangría: marcada con el tabulador del teclado o a 5 espacios.
• Alineación del texto: a la izquierda, también llamado quebrado o en bandera.

P á g i n a 6 | 10
DIANA EMILY CRUZ GARCÍA
Encabezados
Los encabezados no llevan números, ni tampoco mayúsculas sostenidas.
• Nivel 1: Encabezado centrado en negrita, con mayúscula y minúsculas
• Nivel 2: Encabezado alineado a la izquierda en negritas con mayúsculas y minúsculas
• Nivel 3: Encabezado de párrafo con sangría, negrita, mayúscula, minúscula y punto final.
• Nivel 4: Encabezado de párrafo con sangría, negrita, cursiva, mayúscula, minúscula y
punto final.
• Nivel 5: Encabezado de párrafo con sangría, cursiva, mayúscula, minúscula y punto final.
Seriación
Según el Manual se usa la seriación con viñetas o números. Si se hace con números, éstos deben
ser arábigos seguidos de un punto (1.), (2.).

Citación
En el Manual APA, las normas empleadas se basan en un sistema de Autor-Fecha y siempre se
privilegia el número de página para las citas directas o indirectas.

Las citas directas

Estas reproducen de forma exacta el material, sin cambios o añadidos. Se debe indicar el autor,
año y número de página. Si la fuente citada no tiene paginación, entonces se escribe el número
de párrafo. Si la cita tiene menos de 40 palabras se coloca como parte del cuerpo del texto, entre
comillas y al final entre paréntesis se señalan los datos de la referencia.

Normativas principales en documentos.

Las principales normas en Documentación son las siguientes:
• Normas ISO
• Números Normalizados
o International Standard Book Number (ISBN)
o International Standard Serial Number (ISSN)
o International Standard Recording Code (ISRC)
o International Standard Technical Report Number (ISRN)
o International Standard Music Number (ISMN)
o International Standard Audiovisual Number (ISAN)
P á g i n a 7 | 10
DIANA EMILY CRUZ GARCÍA
 o Serial Item and Contribution Identifier (SICI)
o Depósito Legal
• Normas Generales para Catalogación y Descripción bibliográfica:
o Normas ISO para Referencias Bibliográficas de Documentos electrónicos
o ISBD
o ISBD (ER)
o Normas GARE
o Estándar Z39.50
o Estándar Z39.71
o Formato MARC
o Formato UNIMARC
o Reglas Angloamericanas AACR2
o Reglas de Catalogación españolas
• Otras Normas de interés

P á g i n a 8 | 10
DIANA EMILY CRUZ GARCÍA
Bibliografía.

• Asana. (2022, July 6). Los 7 componentes clave de la plantilla para documentos de
requisitos comerciales [2022] •. Asana. https://asana.com/es/resources/business-
requirements-document-template
• Atlassian. (n.d.). Importancia de la documentación. Atlassian. Retrieved April 27, 2023,
from https://www.atlassian.com/es/work-management/knowledge-
sharing/documentation/importance-of-documentation
• de https://normas-apa.org/, E. C. el C. (n.d.). Guía Normas APA. Normas-apa.org.
Retrieved April 27, 2023, from https://normas-apa.org/wp-content/uploads/Guia-Normas-
APA-7ma-edicion.pdf
• La importancia de documentar los proyectos. (n.d.). Go4it.solutions. Retrieved April 27,
2023, from https://go4it.solutions/es/blog/la-importancia-de-documentar-los-proyectos
• Rivas, A. (2023, March 6). Normas APA con plantilla y generador 2023 - Séptima edición.
Normas APA. https://normasapa.in/
• seeco11_C. (n.d.). Gob.Mx. Retrieved April 27, 2023, from
https://www.dof.gob.mx/normasOficiales/6499/seeco11_C/seeco11_C.html
• Verdoy, Á. (2013, August 1). ¿Cómo documentar un proyecto web? 5 reglas básicas y 5
pasos. Socialancer. https://www.socialancer.com/como-documentar-un-proyecto-web/
• ¿Qué son las normas APA y como usarlas en tu tesis? - Consejos y tips. (n.d.). UNIVERSIA
PERU. ORIENTACI�N PROFESIONAL. CARRERAS PROFESIONALES. Retrieved
April 27, 2023, from
https://orientacion.universia.edu.pe/infodetail/orientacion/consejos/que-son-las-normas-
apa-y-como-usarlas-en-tu-tesis-4246.html
• (N.d.-a). Unirioja.Es. Retrieved April 27, 2023, from
http://biblioteca.unirioja.es/biblio/bdg/bdgcitas.pdf
• (N.d.-b). Documentalistas.com. Retrieved April 27, 2023, from
http://www.documentalistas.com/web/biblios/articulos/16/2003_027.pdf

P á g i n a 9 | 10
DIANA EMILY CRUZ GARCÍA
ESTRUCTURA DEL REPORTE:

Ilustración 1. Bosquejo de mi página web.

P á g i n a 10 | 10
DIANA EMILY CRUZ GARCÍA