[go: up one dir, main page]

0% encontró este documento útil (0 votos)
20 vistas16 páginas

Documento Estandares de Codificacion

El documento establece estándares de codificación para el desarrollo de software en un centro de adopción de mascotas, destacando la importancia de la consistencia y legibilidad del código. Se detallan las tecnologías a utilizar, buenas prácticas de nomenclatura, y se presentan directrices para el uso de herramientas de análisis como Saiku Analytics y Pentaho Schema Workbench. El objetivo es asegurar un desarrollo eficiente, mantenible y accesible, facilitando la colaboración y la escalabilidad del proyecto.
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
0% encontró este documento útil (0 votos)
20 vistas16 páginas

Documento Estandares de Codificacion

El documento establece estándares de codificación para el desarrollo de software en un centro de adopción de mascotas, destacando la importancia de la consistencia y legibilidad del código. Se detallan las tecnologías a utilizar, buenas prácticas de nomenclatura, y se presentan directrices para el uso de herramientas de análisis como Saiku Analytics y Pentaho Schema Workbench. El objetivo es asegurar un desarrollo eficiente, mantenible y accesible, facilitando la colaboración y la escalabilidad del proyecto.
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 16

TECNOLOGIA EN ANALISIS Y DESARROLLO DE SOFWARE

SERVICIO NACIONAL DE APRENDIZAJE-SENA

APRENDIZ:

INSTRUCTOR:

CENTRO NACIONAL COLOMBO ALEMÁN


SENA
2024
TRABAJO
DEFINIR ESTANDARES DE CODIFICACION DEACUERDO A PLATAFORMA DE DESARROLLO
ELEGIDA. GA7-220501096-AA1-EV02

PRESENTADO POR

TECNOLOGIA EN ANALISIS Y DESARROLLO DE SOFWARE


SERVICIO NACIONAL DE APRENDIZAJE-SENA
CALI-VALLE
2024
Contenido
INTRODUCCIÓN ................................................................................................................................... 4
1. Objetivo ........................................................................................................................................... 5
2. Alcance ............................................................................................................................................ 5
3. responsables ..................................................................................................................................... 5
4. proposito .......................................................................................................................................... 5
5. Estándares de Programación ........................................................................................................... 5
6. Nombre de Funciones y Procedimientos .......................................................................................... 6
7. Estructura de Código Fuente ............................................................................................................ 7
8. Estructura de un diagrama estrella y cubo ....................................................................................... 8
9. Estándar de trabajo con Saiku Analytics ......................................................................................... 10
10. Estándar de trabajo con Pentaho Schema WorkBench ............................................................... 12
11. Creacion de roles .......................................................................................................................... 13
12. excepciones ................................................................................................................................. 14
Conclusión ......................................................................................................................................... 15
Bibliografía ......................................................................................................................................... 16
INTRODUCCIÓN

La implementación de estándares de codificación rigurosos y adaptados a la plataforma de


desarrollo elegida es fundamental para el éxito a largo plazo de un proyecto de software en un
centro de adopción de mascotas.

Al establecer un conjunto claro de normas y convenciones, los desarrolladores pueden trabajar de


manera más eficiente y colaborativa, lo que se traduce en:

 Código más legible y mantenible: Facilita la comprensión, actualización y depuración del


software.
 Menor tiempo de desarrollo: Al evitar errores comunes y optimizar procesos, se agiliza el
desarrollo de nuevas funcionalidades.
 Mayor calidad del software: Se reduce la probabilidad de bugs y se mejora la estabilidad
del sistema.
 Facilidad de colaboración: Un código consistente facilita el trabajo en equipo y la
transferencia de conocimiento.
 Escalabilidad: Los estándares permiten adaptar el software a las crecientes necesidades
del centro de adopción.

En resumen, los estándares de codificación son una inversión que garantiza la sostenibilidad y el
crecimiento del proyecto a largo plazo.
1. Objetivo
El objetivo de estos estándares es asegurar que el desarrollo de la plataforma web para el centro
de adopción de mascotas siga una estructura coherente, eficiente y de fácil mantenimiento. Estos
estándares buscan garantizar una codificación consistente, ordenada y compatible con las mejores
prácticas de desarrollo web.

2. Alcance
Los estándares de codificación son aplicables a todos los desarrolladores que participen en el
diseño, implementación, y mantenimiento del sitio web del centro de adopción de mascotas,
utilizando HTML, CSS y JavaScript como principales tecnologías.

3. responsables
Subdirección de sistemas y desarrolladores de software.

4. proposito
Asegurarse de que el código sea limpio, estructurado y fácil de leer, facilitando su comprensión
tanto para los desarrolladores actuales como para aquellos que trabajen en él en el futuro.
también debe Garantizar que el sitio sea accesible para todos los usuarios, incluyendo aquellos con
discapacidades, y que la experiencia de usuario sea intuitiva y satisfactoria.

En resumen, el propósito de los estándares de codificación es asegurar la calidad, mantenibilidad y


eficiencia del proyecto, facilitando el desarrollo tanto a corto como a largo plazo.

5. Estándares de Programación
I. Plataformas:
 Lenguaje de programación: HTML5, CSS3 y JavaScript.
 Framework o librerías recomendadas: Bootstrap para el diseño responsivo, y jQuery para
facilitar la manipulación del DOM.
 Servidor web: Apache, Nginx o cualquier servidor HTTP compatible con tecnologías web.
 Gestión de versiones: Git para el control de versiones del código. GitHub/GitLab/Bitbucket
 Plataforma gestión de proyecto: Estas plataformas ayudan a gestionar tareas, asignar
responsabilidades y monitorear el progreso del proyecto, Trello o jira.
 Plataforma de diseño de prototipo: sirve para crear los diseños visuales antes de escribir el
código, Figma y adobe XD.
 Plataforma de despliegue (Deployment), Netlify, Heroku, AWS (Amazon Web Services) ,
Digital Ocean.
 Plataforma Fronted: Bootstrap, Tailwind CSS y React.

II. II.Backup:
 Si el proyecto del centro de adopción necesita un backend para manejar bases de datos de
adopciones o gestionar usuarios, se pueden usar las siguientes plataformas: Node.js, PHP
con Laravel y Firebase.

III. Base de datos:


 Si la aplicación necesita almacenar datos, como información sobre las mascotas y los
adoptantes, estas plataformas serán útiles: MySQL/PostgreSQL y MongoDB.

IV. Plataformas de Monitorización y Seguridad:


 Para asegurar que el sitio web esté en funcionamiento y protegido contra ataques, estas
plataformas son esenciales: Google Analytics y Cloudflare.

6. Nombre de Funciones y Procedimientos

Al definir nombres de funciones y procedimientos en el desarrollo de una aplicación web para un


centro de adopción de mascotas, es importante seguir buenas prácticas de nomenclatura que
aseguren la claridad, coherencia y mantenibilidad del código. A continuación, se describen
recomendaciones y ejemplos específicos de funciones y procedimientos en JavaScript y otros
lenguajes de programación utilizados en el desarrollo web.

1. Buenas Prácticas para Nombrar Funciones y Procedimientos

 Nombres Descriptivos: Los nombres de las funciones deben describir de manera clara la
acción que realizan. Esto mejora la legibilidad del código y facilita la colaboración.
 Verbos en Nombres de Funciones: Los nombres de las funciones deben comenzar con un
verbo que indique lo que la función hará. Ejemplos de verbos comunes son: get, set,
update, delete, load, save, etc.
 CamelCase: Se recomienda usar camelCase para nombrar funciones y procedimientos, es
decir, comenzar la primera palabra con minúscula y las siguientes con mayúscula. Ejempló:
getAdoptedPets(), loadGallery()
 Evitar Nombres Abreviados o Crípticos: Los nombres deben ser lo suficientemente claros
para que cualquiera pueda entender su propósito sin necesidad de revisar el código
interno de la función.
 Consistencia: Mantener un patrón consistente en la nomenclatura de funciones y
procedimientos a lo largo del proyecto para facilitar la lectura.

7. Estructura de Código Fuente

7.1. HTML

 Seguir el estándar de HTML5, asegurando la correcta utilización de etiquetas semánticas


como <header>, <main>, <section>, y <footer>.
 Utilizar indentación de 2 espacios para mejorar la legibilidad del código.
 Evitar el uso de atributos en línea. Todos los estilos deben estar en el archivo CSS externo.
<section class="hero">
<h2>¡Encuentra a tu nuevo mejor amigo!</h2>
<p>Explora nuestra lista de mascotas disponibles para adopción.</p>
<a href="adopt.html" class="button">Ver Mascotas</a>
</section>

7.2. CSS

 Todo el código CSS debe estar en un archivo externo (styles.css) y seguir la


metodología de Block-Element-Modifier (BEM) para las clases.
 Los colores, márgenes y paddings deben estar definidos en variables cuando sea
posible.
 Ejemplo de CSS:
.hero {
background-image: url('../images/fondo.jpg');
padding: 50px;
text-align: center;
}

.hero title {
color: #fff;
font-size: 2.5em;
}

.button {
background-color: #4CAF50;
color: white;
padding: 15px;
}

7.3. JavaScript

 El código JavaScript debe estar ubicado en un archivo separado (scripts.js).


 Utilizar funciones reutilizables y modularizar el código cuando sea posible.
 Evitar el uso de variables globales. Utilizar let o const en lugar de var.
document.getElementById('submitButton').addEventListener('click', function() {
validarFormulario();
});

function validarFormulario() {
// Código de validación
}

8. Estructura de un diagrama estrella y cubo

Un diagrama de estructura para un centro de adopción de mascotas permite visualizar las


diferentes partes del sistema, cómo se conectan entre sí y cómo interactúan con los usuarios. Este
tipo de diagramas es útil para planificar y documentar el desarrollo, asegurando que todas las
partes del sistema estén bien conectadas y comprendidas por los equipos de desarrollo y diseño.

Diagrama Estrella: Es ideal para la estructura de datos operativos, permitiendo una gestión y
consulta eficiente de datos básicos. Es útil para reportes regulares y análisis simples.
Cubo OLAP: Ofrece capacidades avanzadas para el análisis multidimensional, permitiendo una
comprensión más profunda de los datos. Es adecuado para el análisis complejo y la exploración
detallada de tendencias y patrones.Un cubo OLAP para un centro de adopción típicamente incluye
las siguientes dimensiones y medidas:

Dimensiones:

Mascota: Especie, raza, edad, tamaño, estado de salud, etc.

Adoptante: Nombre, apellido, edad, género, ubicación, historial de adopciones.

Empleado: Nombre, cargo, antigüedad, sucursal asignada.

Sucursal: Ubicación, tamaño, número de empleados.

Tiempo: Fecha, mes, año, día de la semana, festivos.

Método de adopción: Adopción directa, adopción foster, etc.

Medidas:

Número de adopciones: Total de adopciones por período.

Ingreso total: Ingresos generados por las adopciones.

Costo promedio por adopción: Costo asociado a cada adopción.

Tiempo promedio de estancia: Tiempo que una mascota permanece en el centro antes de ser
adoptada.

Ambos enfoques son complementarios: el diagrama estrella proporciona la base de datos


operativa, mientras que el cubo OLAP facilita el análisis avanzado. La combinación de ambos
permitirá gestionar y analizar los datos del centro de adopción de mascotas de manera efectiva,
apoyando tanto la operación diaria como la toma de decisiones estratégica.
6. Estándar de trabajo con Saiku Analytics

Utilizar Saiku Analytics para analizar datos relacionados con la adopción de mascotas, generar
informes y visualizar tendencias para apoyar la toma de decisiones y mejorar las operaciones del
centro.

Procedimientos

1. Preparación de Datos:

Importación de Datos:

 Importar datos desde fuentes de datos relevantes (bases de datos, hojas de cálculo, etc.).
 Asegurarse de que los datos estén actualizados y en el formato adecuado para el análisis.
 Limpieza de Datos:
 Revisar y corregir datos incompletos o incorrectos.
 Realizar transformaciones necesarias para asegurar la calidad de los datos.

2. Configuración de Saiku Analytics:

Conexión a Datos:

 Configurar las conexiones a las fuentes de datos en Saiku Analytics.


 Verificar que las conexiones funcionen correctamente y que los datos se sincronicen
adecuadamente.

Creación de Cubos OLAP:

 Definir y construir cubos OLAP que incluyan dimensiones y medidas relevantes (e.g.,
tiempo, especie de mascota, cliente, empleado).
 Configurar jerarquías y niveles dentro de los cubos para facilitar el análisis
multidimensional.

3. Análisis y Visualización de Datos:


 Creación de Informes:
 Diseñar y generar informes que resalten métricas clave (e.g., número de adopciones por
mes, costos de adopción, duración de estancia).
 Incluir gráficos y tablas que permitan una visualización clara de los datos.
 Desarrollo de Dashboards:
 Crear dashboards interactivos para monitorear indicadores clave de rendimiento (KPI).
 Configurar filtros y opciones de segmentación para permitir un análisis detallado.
4. Generación de Insights y Toma de Decisiones:
 Análisis de Tendencias:
 Utilizar Saiku Analytics para identificar tendencias en los datos de adopción (e.g., aumento
de adopciones durante ciertas épocas del año).
 Analizar el impacto de campañas y promociones sobre las adopciones.
 Informes de Gestión:
 Preparar informes para la alta dirección que resuman los hallazgos clave y ofrezcan
recomendaciones basadas en los datos analizados.

5. Capacitación y Soporte:
 Capacitación del Personal:
 Proporcionar formación a los usuarios sobre cómo utilizar Saiku Analytics, interpretar
informes y dashboards.
 Incluir prácticas recomendadas para asegurar una utilización efectiva de la herramienta.
 Soporte Técnico:
 Establecer un protocolo para resolver problemas técnicos o dudas sobre el uso de Saiku
Analytics.
 Mantener documentación actualizada sobre procedimientos y soluciones comunes.

6. Revisión y Actualización:
 Revisión Periódica:
 Revisar y actualizar los cubos OLAP, informes y dashboards según sea necesario para
reflejar cambios en los datos o en los requisitos de análisis.
 Evaluar el rendimiento de Saiku Analytics y realizar ajustes para mejorar la eficiencia.
 Actualización de Procedimientos:
 Ajustar los procedimientos de trabajo en función de nuevas necesidades o mejoras en
Saiku Analytics.

Documentación

 Manual de Usuario de Saiku Analytics: Documentación que detalla cómo utilizar la


herramienta, cómo crear informes y dashboards, y cómo interpretar los datos.
 Protocolos de Importación y Limpieza de Datos: Instrucciones para la correcta importación
y preparación de datos antes del análisis.
 Guía de Análisis e Interpretación de Datos: Directrices para interpretar los resultados y
generar insights útiles para la toma de decisiones.

Cumplimiento y Auditoría

 Verificación del Uso: Realizar auditorías periódicas para asegurar que Saiku Analytics se
esté utilizando según los procedimientos establecidos.
 Gestión de Desviaciones: Identificar y corregir cualquier desviación de los procedimientos y
actualizar el estándar de trabajo según sea necesario.

Implementar un estándar de trabajo para Saiku Analytics en un centro de adopción de mascotas


ayudará a gestionar eficazmente los datos, generar informes significativos y tomar decisiones
basadas en información precisa. Al seguir estos procedimientos, el centro puede optimizar sus
operaciones, mejorar la eficiencia y obtener valiosos insights para mejorar la experiencia de
adopción y el bienestar de las mascotas.

10. Estándar de trabajo con Pentaho Schema


WorkBench

Establecer las directrices para la creación y mantenimiento de esquemas OLAP usando Pentaho
Schema Workbench, con el fin de estructurar datos y permitir su análisis mediante cubos de datos
en un entorno de adopción de mascotas.

El uso de Pentaho Schema Workbench para la creación de esquemas OLAP en un centro de


adopción de mascotas permite estructurar y analizar los datos de forma eficiente. Este estándar de
trabajo asegura que los cubos OLAP se configuren correctamente, proporcionando a los usuarios
las herramientas necesarias para obtener insights significativos sobre las adopciones, costos y
rendimiento del centro. La combinación de un proceso bien definido, pruebas rigurosas y
mantenimiento continuo garantizará la efectividad del análisis de datos en la organización.

11. Creacion de roles

Roles Ejemplares para un Centro de Adopción de Mascotas con un Sistema OLAP.

I. Administrador del Sistema:


 Acceso completo al sistema de análisis.
 Gestiona la creación y modificación de esquemas OLAP.
 Permisos para administrar usuarios y roles.

II. Analista de Datos:


 Crea y gestiona cubos OLAP y consultas complejas.
 Ejecuta análisis multidimensionales y genera informes detallados.
 No tiene acceso a la gestión del sistema ni a la administración de usuarios.

III. Personal de Adopción:


 Puede consultar los datos relacionados con adopciones.
 Genera informes básicos de adopciones, ingresos y estadísticas de mascotas.
 Acceso limitado a herramientas de análisis avanzado.

IV. Directivo:
 Acceso de solo lectura a informes de alto nivel y dashboards.
 Visualiza métricas clave, pero no puede modificar informes ni acceder a configuraciones
avanzadas.

La creación y gestión de roles en un sistema de análisis de datos, como Pentaho, garantiza que los
usuarios tengan acceso a las herramientas y datos adecuados según sus responsabilidades. Un
enfoque bien estructurado para definir y asignar roles mejora la seguridad, facilita la
administración del sistema y asegura un uso eficiente de los recursos disponibles, lo cual es
especialmente importante en un centro de adopción de mascotas para tomar decisiones
informadas y seguras.
12. excepciones

Definir el manejo de excepciones en los procesos relacionados con la creación, administración y


uso de esquemas OLAP, cubos de datos y análisis, para asegurar la continuidad operativa y la
integridad de los datos.

Este procedimiento aplica a todas las situaciones donde los procesos establecidos no pueden
completarse según lo planeado, o cuando surgen eventos inesperados, como errores de datos,
problemas técnicos o discrepancias en los permisos de usuarios.

El manejo adecuado de las excepciones garantiza que el sistema de análisis de datos funcione de
manera eficiente y segura, minimizando el impacto de errores técnicos, problemas de datos o
inconsistencias en los permisos. Establecer procedimientos claros para identificar, resolver y
documentar excepciones permite mantener la integridad del sistema y mejorar continuamente las
operaciones en un centro de adopción de mascotas o en cualquier organización que utilice
herramientas de análisis de datos.
Conclusión

Adoptar y seguir estándares de programación no solo mejora la calidad del software, sino que
también optimiza la eficiencia del desarrollo, facilita el trabajo en equipo y reduce el riesgo de
errores y vulnerabilidades. En resumen, los estándares son una inversión crucial en el éxito a largo
plazo de cualquier proyecto de software, garantizando que el código sea robusto, seguro y
mantenible.
Bibliografía

https://zajuna.sena.edu.co/Repositorio/Titulada/institution/SENA/Tecnologia/228118/Contenido/
OVA/CF28/index.html#/curso/tema2

También podría gustarte