Notas de Implementación

Información de Versión del Producto

Impacto del proceso: Este documento es una discusión técnica breve y conscisa de cómo trabaja el sistema en condiciones ideales. También se le conoce como el documento de "teoría de operación". En este documento se deben describir los algoritmos principales, dependencias de tecnología, y problemas operacionales. Mucho del contenido de este documento puede ser obtenido de los documentos de diseño. Este documento será usado por los grupos de QA, soporte técnico y operaciones. El objetivo es dar a esos grupos la información que necesitan para entender, administrar o empezar a corregir el sistema (por ejemplo, reconociendo ciertos comportamientos como normales o anormales). Si es significativamente necesaria más información, esta deberá organizarse en una "guía de operaciones" más grande.

Tipo de Implementación

TAREAS: Llene la información que ayudará a otros ingenieros a entender este sistema en un vistazo. Siéntase libre de usar información técnica relevante y nombre plataformas tecnológicas específicas.
Tipo de sistema:
Aplicación Gráfica de escritorio
Comando tipo Unix
Aplicación web de servidor
Servicio web
Applet del lado del cliente
Aplicación incrustada
Librería reutilizable
Estructura de clases reutilizable
Plug-in para navegador
Lenguaje(s) de Programación:
Java
Perl, scripts de shell para Unix
Almacenamiento de Datos:
Archivos planos usando XML
Archivos planos usando el formato de propiedades de archivo de Java
Archivos planos usando el formato de serialización de objetos de Java
Base de datos SQL: MySQL
Tecnologías para UI:
Java Swing
XHTML, CSS, JavaScript
Tecnología para Seguridad:
Autentificación: No es necesaria
Autentificación: Archivo local con nombre de usuario y contraseña
Autentificación: LDAP
Autorización: Permisos de archivos del sistema operativo y banderas de lectura-escritura-ejecución
Autorización: Listas de control de acceso
Encriptación: No es necesaria
Encriptación: SSL

Ambiente de Tiempo de Ejecución

TAREAS: Enumere y describa los objetos de tiempo de ejecución que permiten correr al sistema. Estos objetos pueden ser referenciados por nombre en las secciones abajo.
Procesos:
Proceso principal de la aplicación
Procesos del cliente y el servidor
Tareas Cron
COntroladores o servicios del sistema operativo
Archivos de configuración:
NOMBREDELPRODUCTO.conf: almacena configuración de la aplicación en formato de archivo de propiedades Java.
Sección de httpd.conf: configura componentes del servidor web Apache
Tablas de la Base de Datos:
TABLA_UNO:Cada fila representa ...
TABLA_DOS: Cada fila representa ...
TABLA_TRES: Cada fila representa ...
Vea el documento de diseño de persistencia.
Archivos de Datos:
*.ext: Archivos de sistema creados por en el usuario en su disco duro local.
/var/NOMBREDEPRODUCTO/upload-XXXX.dat: Archivos subidos al servidor.
Archivos temporales:
/tmp/NOMBREDELPRODUCTO.pid: ID del proceso que está corriendo el proceso del servidor.
/tmp/upload-XXXX.dat: Archivos subidos al servidor antes de ser procesados.
Archivos de registro:
error.log: Errores serios son puestos en el registro normal de errores de Apache. Debe tener permisos de escritura por un usuario httpd Unix.
NOMBREDELPRODUCTO.log: Mensajes que indican el progreso de operaciones normales y algunos errores. Debe tener permisos de escritura por usuario httpd Unix.
Los archivos de registro son rotados por las noches. Los registros antiguos son archivados en OTRO LUGAR.

Implementación de Características Específicas

TAREAS: Escriba descripciones cortas de algoritmos interesantes o inesperados, suposiciones limítrofes o cualquier otro detalle de implementación que pueda impactar el trabajo de otros grupos. Por ejemplo, operaciones de proceso largo que no deban ser interrumpidas. Por ejemplo, inicar o cancelar scripts que son ejecutados automáticamente por el sistema operativo.

Procedimientos Operacionales

TAREAS: Describa brevemente los procedimientos que deberían ser seguidos por los ingenieros de operaciones cuando el sistema es ejecutado en un ambiente de producción ASP.
Instalación: Vea la Guía de Instalación
Actualización: Vea la Guía de Instalación
Iniciar el Servidor:
  1. PASO
  2. PASO
  3. PASO
Detener el Servidor:
  1. PASO
  2. PASO
  3. PASO
Recargar los Archivos de Configuración:
  1. PASO
  2. PASO
  3. PASO
Monitoreo de la Actividad: Observe NOMBREDELPRODUCTO.log y error.log.
Limpieza Periódica: En raras ocasiones, los archivos /tmp/upload-XXXX.dat pueden acumularse. Cualquiera de estos archivos con más de un día de antiguedad pueden ser eliminados con seguridad.

Securidad

TAREAS: Escriba notas sobre seguridad para ayudar a los ingenieros de operaciones a mantener el sistema seguro mientras se encuentre en operación.

Tuvimos las siguientes precauciones para hacer el sistema seguro:

La seguridad del sistema depende de los siguientes factores externos:

Desempeño y Escalabilidad

TAREAS: Escriba notas sobre el desempeño y la escalabilidad para ayudar a los ingenieros de operaciones a operar el sistema eficientemente.

NOTAS SOBRE DESEMPEÑO.

NOTAS SOBRE ESCALABILIDAD.

Lista de Pendientes de Implementación

¿Estas notas de implementación proveen suficiente información para los ingenieros de operaciones?
Sí, estas notas han sido revisadas por el equipo de operaciones y los cambios solicitados han sido incluídos.
No, estas notas solo resumen partes de un manual de operationes más completo.
No, un miembro del equipo de desarrollo está disponible por teléfono cuando el equipo de operaciones necesite apoyo. Esto se encuentra documentado en el documento recursos necesarios y en el calendario de llamadas.
¿Estas notas de implementación han sido comunicadas a los equipos de operaciones y desarrollo y a otros inversionistas?
Sí, todos han tenido oportunidad de revisarlas. Toda retroalimentación es bienvenida.
Sí, han sido publicadas en el sitio web del proyecto.
No, algunos ingenieros de desarrollo o de operaciones no están conscientes de este documento. Este es un riesgo documentado en la sección Administración de Riesgos del Plan del Proyecto.
TAREAS: Revisar las notas de sabiduría y discutir formas de mejorar esta plantilla.
Compañía Propietaria
Copyright © 2003 Jason Robbins. Todos los derechos reservados. Términos de la Licencia. Mantenga esta leyenda derechos donde utilice este archivo como plantilla - Traducción al español por Interplanet, México, D.F.