ItEr39S07DocumentacionFormacionItEr38S18: Added Navalpro project title to user documentation
This commit is contained in:
Lorenzo Tilve
Javier Moran Rua
parent
5f58870745
commit
8b5f0d592d
11 changed files with 62 additions and 44 deletions
|
|
@ -9,12 +9,12 @@ A aplicación para xestión da produción do sector auxiliar do naval pretende r
|
|||
.. figure:: images/company_view.png
|
||||
:scale: 50
|
||||
|
||||
¿Por que me é útil "______"?
|
||||
============================
|
||||
¿Por que me é útil "Navalpro"?
|
||||
==============================
|
||||
|
||||
"______" é un proxecto desenvolvido co obxectivo de dotar ó usuario dunha ferramenta de planificación que se basea nunha serie de conceptos clave, os cales forman parte das características que distinguen a aplicación e a definen como unha ferramenta diseñada tendo en conta os problemas clave do sector:
|
||||
"Navalpro" é un proxecto desenvolvido co obxectivo de dotar ó usuario dunha ferramenta de planificación que se basea nunha serie de conceptos clave, os cales forman parte das características que distinguen a aplicación e a definen como unha ferramenta diseñada tendo en conta os problemas clave do sector:
|
||||
|
||||
* Vista global de empresa e multiproxecto: "______" é unha aplicación orientada específicamente a dotar de información ós usuarios dos proxectos que se levan a cabo nunha empresa, polo que a base é multiproxecto. Non se determinou que o enfoque do proxecto sexa orientado individualmente a cada proxecto. Sen embargo, tamén será posible dipoñer de varias vistas específicas, entre elas a de proxectos individuais.
|
||||
* Vista global de empresa e multiproxecto: "Navalpro" é unha aplicación orientada específicamente a dotar de información ós usuarios dos proxectos que se levan a cabo nunha empresa, polo que a base é multiproxecto. Non se determinou que o enfoque do proxecto sexa orientado individualmente a cada proxecto. Sen embargo, tamén será posible dipoñer de varias vistas específicas, entre elas a de proxectos individuais.
|
||||
* Criterios: Os criterios son unha entidade do sistema que permitirán clasificar os recursos (tanto humanos como máquinas) e as tarefas. Dende o punto de vista dos recursos, estes satisfarán criterios e, dende o punto de vista das tarefas, estas requerirán criterios a ser satisfeitos. Correspóndense con un dos aspectos máis importantes da aplicación, xa que os criterios formarán parte da base das asignacións xenéricas na aplicación, resolvendo un dos problemas máis importantes para o sector, a alta temporalidade dos recursos humanos e a dificultade para ter estimacións de carga da empresa a longo prazo.
|
||||
* Recursos: Serán de dous tipos diferentes: humanos e máquinas. Os recursos humanos serán os traballadores da empresa que se utilizarán para controlar a carga da empresa e de uso dos mesmos. Por outro lado, as máquinas, dependentes das persoas que as xestionan, serán outros recursos que tamén serán controlables na aplicación.
|
||||
* Asignación de recursos: Unha das claves é o feito de ofrecer a posibilidade de dous tipos diferentes de asignación: asignación específica e asignación xenérica. A xenérica é unha asignación baseada nos criterios que se lle establecen a unha tarefa para ser satisfeitos polos usuarios que teñen a capacidade de realizala.
|
||||
|
|
@ -32,20 +32,18 @@ A maiores das funcionalidades que ofrece a aplicación caben destacar outras car
|
|||
* Xestión de versións: A aplicación permitirá a xestión de diversas versións de planificacións e ó mesmo tempo a posibilidade de consultar a información de cada unha delas.
|
||||
* Xestión de históricos: A aplicación non borra información, solo a invalida, polo que é posible consultar mediante filtrados por datas a información antiga.
|
||||
|
||||
Políticas de usabilidade
|
||||
========================
|
||||
Convencións de usabilidade
|
||||
==========================
|
||||
|
||||
Sección en construción...
|
||||
|
||||
Formularios
|
||||
-----------
|
||||
Comportamento dos formularios
|
||||
-----------------------------
|
||||
Antes de realizar unha exposición das distintas funcionalidades asociadas ós módulos máis importantes, é necesario facer unha explicación xeral da filosofía de navegación e formularios.
|
||||
|
||||
Existen 3 tipos de formularios:
|
||||
Existen fundamentalmente 3 tipos de formularios de edición:
|
||||
|
||||
* Formularios con botón de *Back*. Estes formularios forman parte de unha navegación máis completa, e os cambios que se van realizando vanse almacenando en memoria. Os cambios só se aplican cando o usuario almacena explícitamente toda pantalla dende a que chegou a dito formulario.
|
||||
* Formularios con botón de *Save* e *Close*. Estes formularios permiten realizar 2 operacións. A primeira delas almacena e pecha a ventana actual e a segunda delas pecha sen almacenar os cambios.
|
||||
* Formularios con botón de *Save*, "Save&Close" e "Close. Permiten realizar 3 operacións. A primeira delas almacena pero continúa no formulario actual. A segunda almacena e pecha o formulario. E a terceira pecha a ventana sen almacenar os cambios.
|
||||
* Formularios con botón de *Voltar*. Estes formularios forman parte de unha navegación máis completa, e os cambios que se van realizando vanse almacenando en memoria. Os cambios só se aplican cando o usuario almacena explícitamente toda pantalla dende a que chegou a dito formulario.
|
||||
* Formularios con botón de *Gardar* e *Pechar*. Estes formularios permiten realizar 2 operacións. A primeira delas almacena e pecha a ventana actual e a segunda delas pecha sen almacenar os cambios.
|
||||
* Formularios con botón de *Gardar*, "Gardar e Pechar" e "Pechar". Permiten realizar 3 operacións. A primeira delas almacena pero continúa no formulario actual. A segunda almacena e pecha o formulario. E a terceira pecha a ventana sen almacenar os cambios.
|
||||
|
||||
Iconas e botóns estándar
|
||||
------------------------
|
||||
|
|
@ -56,5 +54,13 @@ Iconas e botóns estándar
|
|||
* Borrado: Os borrados poderán ser realizados coa icona da papeleira.
|
||||
* Procura: A lupa é unha icona que indicará que a entrada de texto á esquerda da mesma está pensada para a procura de elementos.
|
||||
|
||||
Pestanas
|
||||
--------
|
||||
Existirán formularios de edición e administración de contidos que se atopan representados mediante compoñentes gráficos baseados en pestanas. Dita presentación é un mecanismo para organizar a información de un formulario global en diferentes seccións que poden ser accedidas premedo nos
|
||||
títulos das diferentes pestanas, mantendo o estado no que se atopaban as demáis. En todos estes casos, as operacións de gardar ou cancelar que se executen afectarán ó conxunto de subformularios das diferentes pestanas.
|
||||
|
||||
|
||||
Accións explícitas e axuda contextual
|
||||
-------------------------------------
|
||||
Están implementados na aplicación compoñentes que proporcionan un texto descriptivo adicional do elemento sobre que se atopa enfocado o transcurrir un segundo sobre os mesmos.
|
||||
As accións que o usuario pode executar na aplicación están explicitadas tanto nas etiquetas dos botóns e nos textos de axuda que aparecen sobre os mesmos, nas opcións do menú de navegación ou nas opcións dos menús contextuais que se desplegan o facer botón dereito na área do planificador.
|
||||
Asimesmo, tamén se proporcionan atallos ás operacións principais facendo doble click nos elementos que se listan, ou asociando os eventos de teclado cos cursores e a tecla intro ó desplazamento polos formularios é á acción de engadir elementos, respectivamente.
|
||||
|
|
|
|||
|
|
@ -32,13 +32,13 @@ A administración de calendarios está accesible dende as operacións de "Admini
|
|||
Creación dun novo calendario
|
||||
----------------------------
|
||||
|
||||
Para a creación dun novo calendario é necesario premer no botón "______". O sistema amosará un formulario no que o usuario poderá realizar as seguintes operacións:
|
||||
Para a creación dun novo calendario é necesario premer no botón "Navalpro". O sistema amosará un formulario no que o usuario poderá realizar as seguintes operacións:
|
||||
|
||||
* Marcar as horas dispoñibles para cada día da semana (luns, martes, mércores, xoves, venres, sábados e domingos).
|
||||
* Seleccionar un día específico do calendario.
|
||||
* Asignar horas como excepción a un día específico do calendario.
|
||||
|
||||
Con estas operacións un usuario da aplicación ten a capacidade de personalizar os calendarios completamente ás súas necesidades. Para almacenar os cambios no formulario é necesario premer no botón "______".
|
||||
Con estas operacións un usuario da aplicación ten a capacidade de personalizar os calendarios completamente ás súas necesidades. Para almacenar os cambios no formulario é necesario premer no botón "Navalpro".
|
||||
|
||||
.. figure:: images/calendar-edition.png
|
||||
:scale: 70
|
||||
|
|
@ -61,7 +61,7 @@ Para crear un calendario derivado na aplicación, é necesario facer o seguinte:
|
|||
|
||||
* Acceder ó menú de *Administración*.
|
||||
* Premer na operación de administración de calendarios.
|
||||
* Elixir un dos calendarios sobre o que se desexa realizar un derivado e premer no botón "______".
|
||||
* Elixir un dos calendarios sobre o que se desexa realizar un derivado e premer no botón "Navalpro".
|
||||
* Unha vez realizada esta operación o sistema amosará un formulario de edición coas mesmas características que os formularios para crear calendarios dende cero, coa diferencia de que as excepcións e as horas por día da semana se propoñen en base ó calendario orixinal.
|
||||
|
||||
Creación dun calendario por copia
|
||||
|
|
@ -77,7 +77,7 @@ Para crear un calendario copiado na aplicación, é necesario facer o seguinte:
|
|||
|
||||
* Acceder ó menú de *Administración*.
|
||||
* Premer na operación de administración de calendarios.
|
||||
* Elixir un dos calendarios sobre o que se desexa realizar un derivado e premer no botón "______".
|
||||
* Elixir un dos calendarios sobre o que se desexa realizar un derivado e premer no botón "Navalpro".
|
||||
* Unha vez realizada esta operación o sistema amosará un formulario de edición coas mesmas características que os formularios para crear calendarios dende cero, coa diferencia de que as excepcións e as horas por día da semana se propoñen en base ó calendario orixinal.
|
||||
|
||||
Asignación de calendario a recursos
|
||||
|
|
@ -94,13 +94,10 @@ Os casos posibles son:
|
|||
Para asignar un calendario a un recurso é necesario dar os seguintes pasos:
|
||||
|
||||
* Acceder á edición de recursos.
|
||||
* Seleccionar a pestana de "______".
|
||||
* Seleccionar a pestana de "Navalpro".
|
||||
* A partir da pestana anterior aparecerá un formulario de edición de calendarios que permitirá:
|
||||
* Crear un calendario dende cero premendo no botón "______".
|
||||
* Crear un calendario derivado premendo no botón "______".
|
||||
* Crear un botón como copia premendo no botón "______".
|
||||
* Crear un calendario dende cero premendo no botón "Navalpro".
|
||||
* Crear un calendario derivado premendo no botón "Navalpro".
|
||||
* Crear un botón como copia premendo no botón "Navalpro".
|
||||
* O sistema amosará un formulario de edición de calendarios cos datos cargados en base á opción elixida no paso anterior.
|
||||
* Para almacenar é necsario premer en Save.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ O sistema conta con dous tipos de avance creados por defecto:
|
|||
O usuario poderá crear novos tipos de avance do seguinte xeito:
|
||||
|
||||
* O usuario accede á sección de "Administración".
|
||||
* Preme na opción do menú de segundo nivel "______".
|
||||
* Preme na opción do menú de segundo nivel "Navalpro".
|
||||
* O sistema amosa un listado de tipos de avance existentes.
|
||||
* Con cada tipo de avance o usuario poderá:
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ Para introducir medicións de avance será necesario realizar o seguinte:
|
|||
|
||||
* Se non existe ningún tipo de avance é necesario engadir un tipo de avance.
|
||||
|
||||
* No formulario que aparece debaixo cos campos "______" e "______" introducir o valor absoluto da medida e a data que se lle desexa asignar á medida tomada.
|
||||
* No formulario que aparece debaixo cos campos "Navalpro" e "Navalpro" introducir o valor absoluto da medida e a data que se lle desexa asignar á medida tomada.
|
||||
* O sistema almacenará automáticamente os datos introducidos.
|
||||
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ Para introducir medicións de avance será necesario realizar o seguinte:
|
|||
Contraste de avances sobre un elemento do pedido
|
||||
================================================
|
||||
|
||||
Será posible contrastar gráficamente as evolucións dos avances dos pedidos en base ás medicións realizadas. Cada tipo de avance dispón dunha columna con botóns de chequeo (de título "______") o cal ó ser marcado se amosará a gráfica de evolucións de medidas realizadas sobre o elemento de pedido.
|
||||
Será posible contrastar gráficamente as evolucións dos avances dos pedidos en base ás medicións realizadas. Cada tipo de avance dispón dunha columna con botóns de chequeo (de título "Navalpro") o cal ó ser marcado se amosará a gráfica de evolucións de medidas realizadas sobre o elemento de pedido.
|
||||
|
||||
.. figure:: images/contraste-avance.png
|
||||
:scale: 70
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Xestión de traballadores
|
|||
========================
|
||||
|
||||
|
||||
A xestión de traballadores realizarase dende a pestana de "Recursos" e a operación de "______". Dende a lista de recursos é posible editar cada un dos traballadores premendo na icona estándar de edición.
|
||||
A xestión de traballadores realizarase dende a pestana de "Recursos" e a operación de "Navalpro". Dende a lista de recursos é posible editar cada un dos traballadores premendo na icona estándar de edición.
|
||||
|
||||
Unha vez na edición dun recurso, o usuario poderá acceder ás seguintes pestanas:
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ Unha vez na edición dun recurso, o usuario poderá acceder ás seguintes pestan
|
|||
|
||||
2) Pestana de criterios. Dende este punto poderase configurar os criterios que un traballador satisfai. O usuario poderá asignar calquera valor de criterio de tipo traballador ou xenérico que así considere a un traballador. É importante, para que a aplicación sexa utilizada en todo o seu valor, que os traballadores satisfagan criterios. Para asignar criterios o usuario debe:
|
||||
|
||||
i. Premer no botón "______".
|
||||
i. Premer no botón "Navalpro".
|
||||
|
||||
ii. Buscar o criterio que desexa engadir e seleccionar o que encaixe coa súa procura.
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ A edición dunha máquina o sistema maosará unha serie de pestanas dende as cal
|
|||
|
||||
2) Pestana de criterios. Tal e como se comentou na anterior sección de recursos traballadores, esta será a pestana na que se poden engadir criterios que satisfán as diversas máquinas do sistema. Os criterios que serán asignables ás máquinas serán aqueles que se identificaran como criterios de máquina ou xenéricos. Non se poderán asignar criterios de traballadores. Para asignar criterios o usuario deberá:
|
||||
|
||||
i. Premer no botón "______".
|
||||
i. Premer no botón "Navalpro".
|
||||
|
||||
ii. Buscar o criterio que desexa engadir e seleccionar o que encaixe coa súa procura.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Nas seguintes seccións describiranse as operacións que un usuario pode realiza
|
|||
Pedido
|
||||
======
|
||||
|
||||
Un pedido é un proxecto ou traballo que un cliente lle solicita a unha empresa. O pedido para o planificador identifica a entidade de proxecto dentro da empresa. A diferencia das aplicacións de xestión globais, "______" só necesita utilizar certos datos dos pedidos. Estes datos son:
|
||||
Un pedido é un proxecto ou traballo que un cliente lle solicita a unha empresa. O pedido para o planificador identifica a entidade de proxecto dentro da empresa. A diferencia das aplicacións de xestión globais, "Navalpro" só necesita utilizar certos datos dos pedidos. Estes datos son:
|
||||
|
||||
* Nome do pedido
|
||||
* Código do pedido.
|
||||
|
|
@ -109,12 +109,12 @@ Tal e como se pode ver na imaxe, dende a pestana de **etiquetas**, o usuario pod
|
|||
* Visualización das etiquetas que un elemento do pedido terá asociadas por herdanza dun elemento de pedido superior na xerarquía á que lle foi asignada directamente. A tarefa de planificación asociada a cada elemento de pedido terá as mesmas etiquetas asociadas.
|
||||
* Visualización das etiquetas que un elemento do pedido ten asociadas directamente a través do seguinte formulario de asignación de etiquetas inferior.
|
||||
* Asignar etiquetas existentes: Un usuario poderá asignar etiquetas existentes a partir da procura dunha entre as existentes no formulario inferior ó listado de etiquetas directas. Para buscar unha etiqueta chega con premer na icona coa lupa ou escribir o inicio da etiqueta na entrada de texto para que o sistema amose as opcións dispoñibles.
|
||||
* Crear e asignar etiquetas novas: Un usuario poderá crear novas etiquetas asociadas a un tipo de etiquetas existente dende dito formulario. Para relizar a operación é necesario que seleccione un tipo de etiqueta á que se asociará e se introduza o valor da etiqueta para o tipo seleccionado. Premendo en "______ e ______" o sistema xa a creará automáticamente e a asigna ó elemento de pedido.
|
||||
* Crear e asignar etiquetas novas: Un usuario poderá crear novas etiquetas asociadas a un tipo de etiquetas existente dende dito formulario. Para relizar a operación é necesario que seleccione un tipo de etiqueta á que se asociará e se introduza o valor da etiqueta para o tipo seleccionado. Premendo en "Navalpro e Navalpro" o sistema xa a creará automáticamente e a asigna ó elemento de pedido.
|
||||
|
||||
Visualización de horas imputadas a elementos de pedido
|
||||
------------------------------------------------------
|
||||
|
||||
A pestana de "Horas ______" permite visualizar os partes de traballo asociados a un elemento de pedido e ó mesmo tempo permite visualizar cantas horas das presupostadas están xa realizadas.
|
||||
A pestana de "Horas Navalpro" permite visualizar os partes de traballo asociados a un elemento de pedido e ó mesmo tempo permite visualizar cantas horas das presupostadas están xa realizadas.
|
||||
|
||||
.. figure:: images/order-element-hours.png
|
||||
:scale: 70
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
Partes de traballo
|
||||
##################
|
||||
|
||||
.. figure:: images/company_view.png
|
||||
:scale: 1
|
||||
|
||||
.. contents::
|
||||
|
||||
Contidos...
|
||||
|
|
|
|||
|
|
@ -30,11 +30,11 @@ Tanto a edición como a creación de etiquetas comparten formulario. Dende dito
|
|||
|
||||
i. O usuario debería seleccionar unha etiqueta a editar ou premer no botón de creación de unha nova.
|
||||
ii. O sistema amosará un formulario con unha entrada de texto para o nome e un listado de entradas de texto coas etiquetas existentes e asignadas.
|
||||
iii. Se o usuario desexa engadir unha nova etiqueta debe premer no botón "______".
|
||||
iii. Se o usuario desexa engadir unha nova etiqueta debe premer no botón "Navalpro".
|
||||
iv. O sistema amosará unha nova fila ó listado con unha entrada de texto baleira que o usuario debe editar.
|
||||
v. O usuario introduce un nome para a etiqueta.
|
||||
vi. O sistema engade o nome ó listado.
|
||||
vii. O usuario preme en "______" para gardar e saír ou "______ e ______" para gardar e continuar editando o formulario.
|
||||
vii. O usuario preme en "Navalpro" para gardar e saír ou "Navalpro e Navalpro" para gardar e continuar editando o formulario.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,17 @@
|
|||
#############################################################################################
|
||||
Documento de usuario para a aplicación de xestión da produción do sector do auxiliar do naval
|
||||
#############################################################################################
|
||||
.. image:: images/logo1.gif
|
||||
:align: left
|
||||
|
||||
:Version: !!git log -1 --format=%H
|
||||
:Date: !!git log -1 --format=%ad
|
||||
#######################################
|
||||
Documentación de usuario da aplicación
|
||||
#######################################
|
||||
|
||||
|
||||
No seguinte documento proporciónase a documentación de axuda necesaria para utilizar a aplicación de xestión da producción do auxiliar do naval Navalpro.
|
||||
|
||||
Esta documentación está organizada do seguinte modo:
|
||||
|
||||
En primeiro lugar descríbense os obxectivos fundamentais da aplicación e o comportamento global da mesma a modo introductorio e como contextualización xeral do uso da mesma.
|
||||
|
||||
A continuación introdúcense as entidades básicas que será necesario administrar para poder empregar todas as funcionalidades de Navalpro e que se mencionarán nas seguintes seccións da documentación.
|
||||
|
||||
Posteriormente, detállanse os procesos completos de creación de pedidos e proxectos, planificación, asignación de recursos, imputación de avances e extración de resultados.
|
||||
|
|
|
|||
BIN
doc/src/user/images/logo1.gif
Normal file
BIN
doc/src/user/images/logo1.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.7 KiB |
|
|
@ -6,11 +6,11 @@ Copyright: This stylesheet has been placed in the public domain - free to edit a
|
|||
*/
|
||||
|
||||
body {
|
||||
font: 100% sans-serif;
|
||||
font: 11px Verdana, Tahoma, sans-serif;
|
||||
background: #ffffff;
|
||||
color: black;
|
||||
margin: 2em;
|
||||
padding: 0em 2em;
|
||||
/* padding: 0em 2em; */
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
# docutils as-is, so you can add markup if needed.
|
||||
#
|
||||
#
|
||||
|
||||
01-introducion Xavier Castaño (xcastanho@igalia.com)
|
||||
02-criterios Xavier Castaño (xcastanho@igalia.com)
|
||||
03-calendarios Xavier Castaño (xcastanho@igalia.com)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue