]> git.llucax.com Git - z.facultad/75.43/tp1.git/blobdiff - docs/informe/informe.html
Aca esta mi bugfixing, para que le llevemos algo que le guste mas.
[z.facultad/75.43/tp1.git] / docs / informe / informe.html
index 719241dfef7adaeef467fac37ac9cf3fd7a026c3..ac1d567d2dfbcfc8642a1c195d99ab9c32eff7d6 100644 (file)
         <h2><a name="modulo_faqs">Modulo de FAQs</a></h2>
                                <h3><a name="faq_listarPreguntas_php">faq.listarPreguntas.php</a></h3>
         <p>
-            Esta página lista las preguntas ingresadas en el sistema. Para cada
-                                               pregunta, se muestra la fecha de creación, el nombre de autor, con su 
-                                               correspondiente foto, la pregunta en si, la posibilidad de accederá a 
-                                               todas las respuestas para dicha pregunta, así como también la posibilidad
-                                               de responder la pregunta ( solo en caso que quien esta logueado en el sistema
-                                               no sea el mismo usuario que formulo la pregunta ). El listado de preguntas 
-                                               aparece paginado cada 2 ( se muestran dos preguntas por pantalla ). Debajo de
-                                               las preguntas aparece el navegador. En caso que el usuario logueado sea un 
-                                               administrador, en la parte inferior de cada pantalla aparece un link que permite
-                                               acceder a la página de baja de preguntas.
+            Esta pagina muestra la lista de preguntas ingresadas al sistema. Permite acceder
+                                               a las respuestas, y en caso de ser posible, darlas de alta. A los administradores,
+                                               tambien les permite acceder a la baja de preguntas.
         </p>
         <div align="center">
             <img src="faq.listarPreguntas.jpg"
         </div>
                                <h3><a name="faq_listarRespuestas_php">faq.listarRespuestas.php</a></h3>
         <p>
-            El listador de respuestas muestra ordenadas por ranking las respuestas a una 
-                                               pregunta seleccionada. Utiliza el paginador, al igual que el listador de preguntas, 
-                                               y también lo hace de a dos respuestas por pantalla. Muestra la información del usuario
-                                               que genero la respuesta ( foto y nombre ), la respuesta y el ranking de la misma. Si la
-                                               respuesta todavía no fue evaluada por el autor de la pregunta, muestra un mensaje que 
-                                               indica que no hay ranking para esa pregunta. Si el usuario que esta accediendo a la lista
-                                               de respuestas es el mismo que formulo la pregunta y todavía no calificó a la misma, aparece 
-                                               un botón que lo redirecciona a la página de calificación de preguntas. 
+            Para cada una de las preguntas, se pueden ver desde esta pantalla las respuestas dadas
+                                               de alta. Las muestra por ranking. En caso de que la respuesta no haya sido calificada
+                                               aun y quien esta logueado es el autor de la pregunta, permite acceder a la pantalla de 
+                                               calificaciones.
         </p>
         <div align="center">
             <img src="faq.listarRespuestas.jpg"
         </div>
                                <h3><a name="faq_ingresarPregunta_php">faq.ingresarPregunta.php</a></h3>
         <p>
-            Desde el menú de la aplicación se puede acceder a esta página. En caso de que el 
-                                               usuario logueado tenga los créditos para hacerlo, podrá formular una pregunta que 
-                                               se publicara en la lista de preguntas ( faq.listarPreguntas.php ). Si el usuario no
-                                               contara con los créditos suficientes, un warning lo alertara y le sugerirá que 
-                                               pida créditos al administrador del sistema. El usuario podrá ingresas desde esta pantalla
-                                               tantas preguntas como créditos tenga. 
+            Permite dar de alta una pregunta en el sistema. Es necesario que el usuario sea un asesor, o
+                                               tenga los creditos suficientes. 
         </p>
         <div align="center">
             <img src="faq.ingresarPregunta.jpg"
         </div>
                                <h3><a name="faq_responderPregunta_php">faq.responderPregunta.php</a></h3>
         <p>
-            Desde el listado de preguntas se puede acceder a la pantalla que permite responder 
-                                               la pregunta. La misma muestra en el encabezado la pregunta que se esta respondiendo. 
-                                               Al lograr un ingreso satisfactorio de una respuesta, aparece un mensaje que avisa al 
-                                               usuario que su respuesta fue dada de alta en el sistema. Esta respuesta quedara pendiente
-                                               de calificar por parte del autor de la pregunta que se esta respondiendo. Cualquier usuario
-                                               logueado en el sistema puede acceder a responder preguntas. Únicamente no podrá responder una
-                                               pregunta el autor de la misma 
+            La pantalla permite ingresar la respuesta a una pregunta seleccionada. Esta respuesta deberá
+                                               ser calificada por el autor de la pregunta posteriormente, y le permitirá al que responde, obtener 
+                                               créditos.
         </p>
         <div align="center">
             <img src="faq.responderPregunta.jpg"
         </div>
                                <h3><a name="faq_calificarRespuesta_php">faq.calificarRespuesta.php</a></h3>
         <p>
-            La pantalla de calificación de respuesta solo puede ser accedida por el autor de
-                                               la pregunta que tiene dicho ítem como respuesta. En esta pantalla, desde un combo, se
-                                               puede elegir alguna de las cuatro categorías de calificación ( a cada una le corresponde un 
-                                               puntaje ). Inmediatamente se le acreditara a quien pregunta tantos créditos como puntos valgan la 
-                                               calificación de la respuesta. La respuesta solo podrá ser calificada una vez, luego de ser calificada,
-                                               desaparecerá el botón que permite acceder a la pantalla para ese ítem. 
+            A esta pantalla solo accede el autor de la pregunta. Desde la misma puede calificar la respuesta.
+                                               Dependiendo de la calidad de la respuesta, quien la formulo podra obtener mas o menos créditos, para
+                                               de esta manera poder efectuar nuevas preguntas.
         </p>
         <div align="center">
             <img src="faq.calificarRespuesta.jpg"
         </div>
                                <h3><a name="faq_desactivarPregunta_php">faq.desactivarPregunta.php</a></h3>
         <p>
-                                        Desde esta pantalla, los administradores pueden dar de baja una pregunta. De todas formas la pregunta
-                                        seguirá existiendo, con sus respuestas, pero no sera mostrada mas por el listador. Para acceder a la pantalla
-                                        de baja de preguntas, se debe hacer click sobre el link que aparece en la página listarPreguntas.php. Este link
-                                        solo aparece en caso que el usuario logueado tenga privilegios de administrador. 
+                                        La pantalla de baja de preguntas solo puede ser accedida por un administrador. Permite que la pregunta
+                                        y sus respuestas no sean listadas mas, pero queden logueadas en un historico.
         </p>
         <div align="center">
             <img src="faq.desactivarPregunta.jpg"
                 alt="Captura de pantalla de info.mencionEspecial.php" />
         </div>
         <h1><a name="desarrollo">Desarrollo</a></h1>
-        <h2><a name="desarrollo_archivos">Formato de Archivos</a></h2>
+        <h2><a name="desarrollo_diseño">Diseño del sistema</a></h2>
+                               <p>
+                                        Los siguientes dos graficos describen como fue pensado el sistema a nivel
+                                        clases, y como se integrarian las diferentes partes, para que, pese a contar
+                                        con tres modulos separados, quede una unica aplicacion homogenea. Como punto de 
+                                        partida entonces se realizaron estos dos graficos que sirvieron como guia, y 
+                                        a lo largo del desarrollo fueron actualizandose. Se adjuntan aqui sus versiones 
+                                        finales.
+                               </p>
+                               <h3><a name="desarrollo_diagrama_clases">Diagrama de Clases</a></h3>
+                               <p>
+                                        El diagrama de clases se penso con el fin de poder reutilizar la mayor cantidad
+                                        de codigo posible, y de dividir de forma mas clara las tareas. La idea de estas
+                                        clases, principalmente, es que sean las entidades que son persistidas en los archivos
+                                        de texto, para tener un manejo mas sencillo y eficiente de la informacion.
+                               </p>
+                               <div align="center">
+            <img src="clases.jpg"
+                alt="Diagrama de clases" />
+        </div>
+                               <h3><a name="desarrollo_diagrama_navegacion">Gráfico de Navegación</a></h3>
+                               <p>
+                                        Este esquema permite ver la interrelación entre las diferentes pantallas del sistema
+                                        y como se puede acceder de una a la otra. Ademas, da una idea a alto nivel de como funciona
+                                        y como aparecen integrados los diferentes elementos.
+                               </p>
+                               <div align="center">
+            <img src="graficoNavegacion.jpg"
+                alt="Gráfico de Navegación" />
+        </div>
+                               <h2><a name="desarrollo_archivos">Formato de Archivos</a></h2>
         <p>
             Todos los archivos del sistema se almacenan en el directorio data.
             Varios archivos son creados en <em>tiempo de ejecución</em> por el
@@ -691,9 +697,65 @@ AddType application/x-httpd-php .php
             donde había abandonado la sesión.
         </p>
         <h2><a name="uso_modulo_faqs">Modulo de FAQs</a></h2>
-               <p>
-               COMPLETAR!
-        </p>
+                               <p>
+                       El módulo se encarga de la administracion de el subsistema de preguntas y
+                                               respuestas. Maneja altas y bajas, asi como tambien ingreso de respuestas y 
+                                               ranking de cada una. Mientras mejor es la respuesta de un usuario (que será
+                                               calificado por el autor de una pregunta), mejor será su puntuación. Esos puntos
+                                               son créditos para poder seguir efectuando preguntas.
+        </p>
+                               <p>
+                                         La página <a href="#faq_listarPreguntas_php">Listar Preguntas</a> muestra 
+                                               las preguntas ingresadas en el sistema. Para cada pregunta, se muestra la fecha 
+                                               de creación, el nombre de autor, con su correspondiente foto, la pregunta en si, 
+                                               la posibilidad de accederá a todas las respuestas para dicha pregunta, así como 
+                                               también la posibilidad de responder la pregunta ( solo en caso que quien esta 
+                                               logueado en el sistema no sea el mismo usuario que formulo la pregunta ). El listado 
+                                               de preguntas aparece paginado cada 2 ( se muestran dos preguntas por pantalla ). 
+                                               Debajo de las preguntas aparece el navegador. En caso que el usuario logueado sea un 
+                                               administrador, en la parte inferior de cada pantalla aparece un link que permite
+                                               acceder a la página de <a href="#faq_desactivarPregunta_php">Baja de Preguntas.</a>
+                               </p>
+                               <p>
+                                         El <a href="#faq_listarRespuestas_php">listador de respuestas</a> muestra ordenadas por ranking 
+                                               las respuestas a una pregunta seleccionada. Utiliza el paginador, al igual que el listador de preguntas, 
+                                               y también lo hace de a dos respuestas por pantalla. Muestra la información del usuario
+                                               que genero la respuesta ( foto y nombre ), la respuesta y el ranking de la misma. Si la
+                                               respuesta todavía no fue evaluada por el autor de la pregunta, muestra un mensaje que 
+                                               indica que no hay ranking para esa pregunta. Si el usuario que esta accediendo a la lista
+                                               de respuestas es el mismo que formulo la pregunta y todavía no calificó a la misma, aparece 
+                                               un botón que lo redirecciona a la página de calificación de preguntas. 
+                               </p>
+                               <p>
+                                         Desde el menú de la aplicación se puede acceder a la página que permite <a href="#faq_ingresarPregunta_php">
+                                               agregar una pregunta</a>. En caso de que el usuario logueado tenga los créditos para hacerlo, podrá formular 
+                                               una pregunta que se publicara en la <a href="#faq_listarPreguntas_php">lista de preguntas</a>. Si el usuario no
+                                               contara con los créditos suficientes, un warning lo alertara y le sugerirá que pida créditos al administrador 
+                                               del sistema. El usuario podrá ingresas desde esta pantalla tantas preguntas como créditos tenga.
+                               </p>
+                               <p>
+                                               Desde el listado de preguntas se puede acceder a la pantalla que permite <a href="#faq_responderPregunta_php"> 
+                                               responder la pregunta </a>. La misma muestra en el encabezado la pregunta que se esta respondiendo. 
+                                               Al lograr un ingreso satisfactorio de una respuesta, aparece un mensaje que avisa al 
+                                               usuario que su respuesta fue dada de alta en el sistema. Esta respuesta quedara pendiente
+                                               de calificar por parte del autor de la pregunta que se esta respondiendo. Cualquier usuario
+                                               logueado en el sistema puede acceder a responder preguntas. Únicamente no podrá responder una
+                                               pregunta el autor de la misma. 
+                               </p>
+                               <p>
+                                         La pantalla de <a href="#faq_calificarRespuesta_php">calificación de respuesta</a> solo puede ser accedida 
+                                               por el autor de la pregunta que tiene dicho ítem como respuesta. En esta pantalla, desde un combo, se
+                                               puede elegir alguna de las cuatro categorías de calificación ( a cada una le corresponde un 
+                                               puntaje ). Inmediatamente se le acreditara a quien pregunta tantos créditos como puntos valgan la 
+                                               calificación de la respuesta. La respuesta solo podrá ser calificada una vez, luego de ser calificada,
+                                               desaparecerá el botón que permite acceder a la pantalla para ese ítem. 
+                               </p>
+                               <p>
+                                         Si un administrador lo desea, desde la pantalla de <a href="#faq_listarPreguntas_php">listado de preguntas</a>
+                                               es posible acceder a la pantalla de <a href="#faq_desactivarPregunta_php">baja de preguntas</a> y pasar una pregunta 
+                                               a un log historico. De esta manera ni la pregunta ni sus respuestas seran mostradas mas por el listador. La lista de preguntas
+                                               a desactivar aparece para seleccionar de un combo.  
+                               </p>
         <h2><a name="uso_modulo_info">Modulo de Info</a></h2>
         <p>
                El módulo de info permite el ingreso de temas, informaciones y comentarios,