LINQ TO AMAZON. Especificación de Requerimientos de Software para Sistema. Versión 2.1

Transcripción

1 LINQ TO AMAZON Especificación de Requerimientos de Software para Sistema Versión 2.1 Historia de revisiones Fecha Versión Descripción Autor 15/08/ Primera versión Paola Iraola, Nicolás Lasarte. 17/08/ Se agrega Nota al pie del documento con referencia a un texto de la sección 2.1. Se corrigen saltos de línea. Paola Iraola, Nicolás Lasarte. 23/08/ Segunda versión, posterior de la Paola Iraola, Nicolás segunda reunión con el cliente Lasarte, Leonardo Lopez. 23/08/ Se modifica el formato y la tabla José Fager de contenido Especificación de Requerimientos Página 1 de 10

2 Contenido 1. INTRODUCCIÓN PROPÓSITO ALCANCE DEFINICIONES, SIGLAS Y ABREVIATURAS REFERENCIAS VISIÓN GENERAL DESCRIPCIÓN GENERAL PERSPECTIVA DEL PRODUCTO Interfases de usuario Interfases con software Restricciones de memoria FUNCIONES DEL PRODUCTO CARACTERÍSTICAS DE LOS USUARIOS RESTRICCIONES DE DISEÑO Restricciones tecnológicas Restricciones legales Restricciones Funcionales SUPUESTOS Y DEPENDENCIAS REQUERIMIENTOS ESPECÍFICOS REQUERIMIENTOS FUNCIONALES REQUERIMIENTOS DE VERIFICACIÓN REQUERIMIENTOS DE CALIDAD REQUERIMIENTOS DEL APLICATIVO EJEMPLO REQUERIMIENTOS SUPLEMENTARIOS PERFORMANCE AUTORIZACIÓN Y LICENCIAMIENTO ESTÁNDARES APLICABLES RECUPERACIÒN ANTE FALLAS REQUERIMIENTOS DE DOCUMENTACIÓN MANUAL DE USUARIO INFORMES PARA EL CLIENTE Especificación de Requerimientos Página 2 de 10

3 1. Introducción El proyecto consiste básicamente en un proveedor LINQ para Amazon que funcione en Silverlight y una aplicación de ejemplo que use dicho proveedor. El proveedor debe cubrir con un mínimo preestablecido de funcionalidades expuestas por los servicios Web de Amazon. Y la aplicación debe permitir a los usuarios hacer búsquedas avanzadas con una interfaz amigable Propósito La confección de un documento formal donde se encuentre la especificación de requerimientos obtenidos mediante reuniones con el cliente (Microsoft Corp.), para una posterior validación de los mismos. Además de ser utilizados como base para el desarrollo del producto Alcance A continuación se especificarán los productos requeridos por el cliente: Proveedor LINQ para Amazon: Este proveedor debe funcionar en Silverlight, debe soportar un mínimo de funcionalidades que expone la Web de Amazon a través de Web Services, las acordadas con el cliente se especifican en el punto 3.1. Además debe implementar un mecanismo de paginado para el manejo de los resultados de las búsquedas realizadas. Aplicación en Silverlight que utilice el proveedor: Debe servir como ejemplo de uso del provider y además debe ser visualmente atractiva para el usuario. No necesariamente debe mostrar todas las funcionalidades del provider, como mínimo debe poder realizar la operación de búsqueda de artículos, al menos libros. Es recomendable la búsqueda de otro tipo de artículos (por ej. dvd). Documentación a modo de tutorial: Se requiere una documentación paso a paso para guiar al usuario en la creación del proveedor LINQ y la construccion de la aplicación que haga uso del mismo sobre Silverlight. Documentación a entregar al cliente: Se mantendrá informado al cliente mediante informes sobre el avance del producto Definiciones, siglas y abreviaturas Ver documento Glosario. Especificación de Requerimientos Página 3 de 10

4 1.4. Referencias Acta de reunión de requerimientos (RQACTG04v1.1.doc). Presentación proporcionada por el cliente (Linq to Amazon.pptx). Propuesta de proyecto para el curso (MS_Propuesta de Proyecto 2008.doc). Web Services de Amazon ( Money/b/ref=sc_iw_l_0_ _2?ie=UTF8&node= &no= &me=A36L942TSJ2AJA). Estándar de Microsoft ( Acta de reunión de requerimientos (RQACTG04v1.1_ doc). Lista de colores utilizables ( Visión general Esta sección describe con más detalle la especificación de requerimientos, obtenidas mediante el Acta de reunión (ver referencias). Se encontrará una descripción general (perspectiva, funciones del producto, características de usuarios, restricciones de diseño y supuestos y dependencias). Luego se detallan los requerimientos, los cuales se agrupan en: específicos, suplementarios y de documentación. 2. Descripción general Se describen los factores claves que afectan a los productos y sus requerimientos Perspectiva del producto Interfases de usuario Se debe permitir al usuario hacer búsquedas avanzadas con una interfaz amigable. Esta debe ser visualmente interesante, innovadora y atractiva 1, maximizando los recursos que Silverlight provee para la realización de la misma. Entre las principales funcionalidades de dicha interfaz se encuentran: la realización de distintas búsquedas (detalladas en el punto 3.1). la presentación paginada de forma eficiente y creativa de los resultados obtenidos en las consultas. Permitir modificar el tamaño de las ventanas, usando coordenadas relativas, permitiendo que la interfaz no se encuentre atada a ninguna configuración específica. 1 Se hace referencia a palabras textuales del cliente expresadas en la primera reunión. Especificación de Requerimientos Página 4 de 10

5 No debe aparecer ningún logotipo corporativo como el de Amazon o Microsoft, en cambio si se podrá utilizar un logotipo de creación propia. Mostrar mensajes de error que describan la causa del mismo y una posible solución. Identificar en que momento el aplicativo reporta un error o ejecución no válida. Ejemplo: Si un usuario al consulta por más ítems que el límite preestablecido el sistema desplegará un mensaje de error. Mostrar una pequeña descripción de cada ítem resultado de la búsqueda y luego permitir seleccionar alguno de ellos para ampliar su descripción. Utilizar colores que no resulten violentos para los usuarios. (Ver referencias). Detectar el idioma del browser para que esta se muestre en el idioma que corresponda. Darle al usuario la posibilidad de realizar una búsqueda avanzada (Con características más específicas) en caso de desearlo, de acuerdo al ítem que eligió Interfases con software Se hará uso de Web Services provistos por Amazon que permiten realizar las mismas operaciones que si se utilizara su sitio Web. El propósito del uso de esta interfaz es la realización de consultas sobre los productos que esta empresa ofrece. Para hacer uso de los Web services que Amazon ofrece (ver referencias). Las posibilidades de comunicación con el Web Service de Amazon se especifican mediante el protocolo SOAP o REST Restricciones de memoria Debido a que las aplicaciones a desarrollar se ejecutan del lado del cliente, si bien no hay una especificación formal, se optimizara el uso de la memoria y de esta manera obtener un mejor rendimiento del producto Funciones del producto Como se detalló en secciones anteriores, entre las funcionalidades mas importantes que el producto debe proveer se encuentran: El desarrollo de un proveedor LINQ para Amazon que funcione en Silverlight. La realización de una aplicación de ejemplo que use dicho proveedor y permita realizar búsquedas avanzadas con una interfaz amigable Características de los usuarios Ya que el producto será usado como ejemplo de desarrollo y el código será usado como base para un ejemplo a publicar en los usuarios deberán poseer un conocimiento básico de desarrollo en Especificación de Requerimientos Página 5 de 10

6 aplicaciones sobre.net,. No necesariamente deben haber trabajado con tecnologías Silverlight o LINQ 2.4. Restricciones de diseño Restricciones tecnológicas El desarrollo debe realizarse sobre plataforma Microsoft. El proyecto debe implementarse en C# 2008 usando Visual Studio 2008 y correr sobre Silverlight 2 Beta 2. Se recomienda como software adicional el uso de Word, Visio, Project, además de otras herramientas que podrán ser utilizadas para documentación/diagramación/project management u otro. Se utilizará CodePlex como repositorio de datos. La licencia a usar es Microsoft Public License (MS-PL) Restricciones legales No se puede copiar y pegar código de ejemplos (todo el código debe ser desarrollado por los implementadores). El còdigo publicado en MSDN es el único que podrá ser usado como base para nuestra implementación. El uso de librerías de terceros como parte del desarrollo es restringido a las que proporcione Amazon que funcionen en Silverlight Restricciones Funcionales El usuario tendrá que esperar el resultado de una consulta antes de poder realizar una nueva, para ello se podría deshabilitar el botón de la búsqueda mientras se espera el resultado. Se pueden devolver como máximo 100 resultados si así lo requiere la consulta Supuestos y dependencias Se preverá un cambio de versión en Silverlight, en caso de realizarse se analizará el impacto del cambio en el producto. La performance del producto depende en gran medida del ancho de banda de la conexión de red, considerando que el cliente posee una mejor conexión, esta cualidad del software quedará sujeta a la evaluación del mismo. Especificación de Requerimientos Página 6 de 10

7 3. Requerimientos específicos 3.1. Requerimientos funcionales El cliente especifica la lista de operaciones que tiene que soportar el provider, priorizadas según los siguientes criterios: - Prioridad 0 = tiene que estar. - Prioridad 1 = debería estar. - Prioridad 3 = estaría bueno que este - Prioridad 99 = no es necesario que este salvo que sea útil para alguna de las otras operaciones o sea tan fácil de implementar que no vale la pena dejarla afuera. Priority Name 0 First 0 FirstOrDefault 0 OrderBy 0 OrderByDescending 0 Select 0 Skip<(Of <(TSource>)>) 0 Take<(Of <(TSource>)>) 0 ThenBy 0 ThenByDescending 0 Where 1 Count 1 ElementAt<(Of <(TSource>)>) 1 ElementAtOrDefault<(Of <(TSource>)>) 1 Last 1 LastOrDefault 1 SkipWhile 1 TakeWhile 3 Aggregate 3 Any Especificación de Requerimientos Página 7 de 10

8 3 Average 3 Contains 3 Distinct 3 GroupBy 3 LongCount 3 Max 3 Min 3 SelectMany 3 Sum 99 All<(Of <(TSource>)>) 99 Cast<(Of <(TResult>)>) 99 Concat<(Of <(TSource>)>) 99 DefaultIfEmpty 99 Except 99 GroupJoin 99 Intersect 99 Join 99 OfType<(Of <(TResult>)>) 99 Reverse<(Of <(TSource>)>) 99 SequenceEqual 99 Single 99 SingleOrDefault 99 Union Se debe proveer un mecanismo de resultados de las búsquedas realizadas. paginado, para el manejo de los El cliente acepta y promueve el uso de los criterios de búsqueda que provee Amazon, es decir, no crear implementaciones locales para realizar operaciones que ya provee Amazon. Por ejemplo: si se pide el elemento 10 no se pueden traer los 100 elementos y elegir el de la posición 10. Debe permitirse volver a filtrar el resultado de una consulta, o sea, tener consultas anidadas y de esta manera ir restringiendo el universo de la búsqueda. Especificación de Requerimientos Página 8 de 10

9 Sería una funcionalidad deseable pero no necesaria que durante la sesión se mantenga una búsqueda realizada. El usuario deberá ingresar la clave de Amazon por medio de la interfaz gráfica para el consumo de los WS. Todas las funcionalidades deben se entregadas funcionando correctamente según lo antes detallado Requerimientos de verificación Los casos de prueba deben cubrir el 70% del código, como meta es deseable por el grupo que se cubra el 100%, para asi obtener una mejora de calidad en el producto. Se entregará una lista detallada de Bugs conocidos de la aplicación. Se entregarán los casos de prueba utilizados Requerimientos de calidad Deben manejarse buenas prácticas de arquitectura y diseño en el producto. En el desarrollo se sugiere que el código y comentarios sean en inglés Requerimientos del aplicativo ejemplo La aplicación debe servir como ejemplo de un conjunto (ya detallado) de funcionalidades del proveedor. Debe ser visualmente atractiva al usuario de acuerdo a la especificación de la interfaz Requerimientos suplementarios Performance Las búsquedas deberán realizarse en menos de 5 segundos, el cliente verificará este punto mediante pruebas en la conexión local Autorización y licenciamiento El producto se debe desarrollar con aplicaciones Microsoft ya detalladas Estándares aplicables El código debe cumplir con el estándar regido por Microsoft (ver referencias). Especificación de Requerimientos Página 9 de 10

10 3.5.4 Recuperaciòn ante fallas En caso de ocurrir pérdida de los servicios, el usuario deberá realizar nuevamente la totalidad de la consulta. 4. Requerimientos de documentación Se especifica el tipo de documentación que se requiere, el contenido y formato de la misma Manual de Usuario Documentación al estilo paso a paso, para guiar al usuario en la construcción, de un provider y de una aplicación que haga uso del mismo. Se sugiere pero no es imprescindible documentación en inglés y en formato HTML Informes para el cliente Se requiere una especificación inicial del producto. Informes de avances semanales, a modo de resumen no muy extensos (no más de un carilla). Reportes de cambios en el alcance y funcionalidad en caso de ser necesarios. Especificación de Requerimientos Página 10 de 10