Project

General

Profile

Manual de usuario de cosmoSys » History » Release 4

Txinto Vaz, 12/01/2025 09:18 PM

1 4 Txinto Vaz
![Logo cosmoBots](https://support.csys.cosmobots.eu/attachments/download/14/cBotsLogo.png)
2 1 Txinto Vaz
3 4 Txinto Vaz
# Manual de Usuario
4
5 1 Txinto Vaz
## Datos del producto
6
- **Nombre del sistema:** cosmoSys
7
- **Version:** _Completar_
8
- **Fecha:** _Completar_
9
- **Responsable de la informacion:** _Completar_
10
11 3 Txinto Vaz
## Vision general
12
cosmoSys esta implementado como un plugin de Redmine y añade varias capacidades:
13
- Representacion grafica de la estructura de items y sus relaciones (incluida una vista/editor de arbol y la vista MainReport) para entender dependencias y jerarquias de un vistazo y reorganizarlas con arrastrar/soltar.
14
- Visualizacion tipo libro: los proyectos pueden verse como un documento con capitulos (items) y subcapitulos (items dentro de items).
15
- Identificadores csID mas legibles y contextuales dentro de cada familia de proyecto para localizar items sin recurrir a IDs globales largos.
16
- Generacion de informes estructurados (DOCX/ODT/HTML) basados en MainReport, con tabla de contenidos viva, diagramas embebidos ajustados a pagina y plantillas personalizables.
17
- Importacion y exportacion enriquecida de items a hojas de calculo ODS con plantillas guiadas.
18
- Herramientas de administracion que automatizan la carga masiva de proyectos a partir de WBS.
19
- Plataforma para otros plugins especializados (p.ej., cosmoSys-Req para gestion profesional de requisitos, cosmoSys-PORIS como repositorio de modelos PORIS, cosmoSys-Git para sincronizar un repositorio Git espejo de un proyecto con las importaciones/exportaciones ODS, y otros).
20
- Referencias documentales mediante items csInfo/csRef y matrices de referencias en MainReport e informes exportados.
21
22 1 Txinto Vaz
## Publico objetivo
23
Personal de una empresa de ingenieria con estructura matricial:
24
- Usuarios asignados a proyectos con roles específicos por proyecto (como en Redmine).
25
- Perfiles habituales: jefes de proyecto, responsables de disciplina, ingenieros de distintas especialidades y PMO.
26
- Nivel técnico: usuarios familiarizados con gestión de tareas/proyectos y uso básico de herramientas web.
27
- Dispositivos: uso principal en escritorio/portátil; acceso web.
28
29
## Requisitos previos
30
- Software necesario: Acceso a una instancia de cosmoSys configurada para la organizacion (adaptada a proyectos y familias).
31
- Accesos y permisos: Credenciales de usuario; permisos de creacion de proyectos otorgados por el administrador cuando aplique.
32
- Datos de prueba o entorno: _Completar_
33
34
## Conceptos clave
35
- **Item**: unidad base (equivalente a una "issue" en Redmine) que en cosmoSys se usa de forma generica para tareas, requisitos o nodos de modelos.
36
- **Relaciones**: enlaces entre items (padre-hijo, depende de, bloquea, duplicado, etc.).
37
- **Familia de proyecto**: conjunto de proyectos de un mismo arbol Redmine (proyecto raiz y todos sus subproyectos). Un proyecto raiz es aquel sin proyecto padre (relacion "parent" vacia). Los items comparten contexto e identificadores legibles dentro de esa familia.
38
- **csID (identificador legible)**: identificador propio de cosmoSys para cada item (formato `csID-proyecto` + guion + numero de 5 cifras). Es unico por familia y no cambia salvo accion explicita de administracion.
39
- **csInfo**: clase de item (tracker en Redmine) orientada a estructurar contenidos en arbol para transcribir a documentos (capitulos/secciones).
40
- **csRef**: clase de item (tracker en Redmine) para referencias documentales (wiki, documentos, URLs, ficheros, citas) clasificadas como documentos de referencia, aplicables o de conformidad.
41
- **Diagrama jerarquico**: diagrama que muestra items padres e hijos como cajas anidadas (analogas a nodos expandidos en el editor de arbol o a capitulos/subcapitulos del MainReport).
42
- **Diagrama de dependencias**: diagrama que muestra items como cajas y relaciones dirigidas (bloquea a, precede a, copiado de, relacionado con). "Relacionado con" es bidireccional; las demas se leen en ambos sentidos (p.ej., bloquea a / es bloqueado por).
43
- **Vista/Editor de arbol**: vista del proyecto que muestra los items como nodos jerarquicos. Permite reorganizar arrastrando y soltando nodos y navegar abriendo/cerrando subarboles.
44
- **MainReport**: vista del proyecto en formato documento; los items se muestran como capitulos y subcapitulos. Permite configurar que campos se muestran/ocultan, si se incluyen diagramas contextuales (diagramas jerarquicos y de dependencias centrados en el item), y filtrar items por tipo o valores de campos. Puede volcarse a DOCX/ODT/HTML.
45
46
## Identificador csID de los items
47 3 Txinto Vaz
- Generacion y formato:
48
  - Prefijo de proyecto (configurable en la ficha del proyecto, sin guiones ni espacios) + `-` + numero de 5 cifras desde `00000` segun orden de creacion en ese proyecto. Ej.: `MPR-00000`.
49
  - Prefijo unico por familia (proyecto raiz y subproyectos); familias distintas pueden compartir prefijos sin conflicto.
50
- Busqueda:
51
  - El buscador de csID parte del proyecto actual, sube al raiz de la familia y recorre todos los subproyectos buscando el prefijo-numero.
52
  - Si hay coincidencia en proyecto e item, se prioriza el item; si no se encuentra, se informa que no existe en la familia y se sugiere verificar prefijo/numero.
53
- Movimientos e inmutabilidad:
54
  - Mover items dentro de la misma familia no cambia el csID.
55
  - Solo una accion administrativa explicita puede renombrar un csID; se desaconseja para no romper trazabilidad (ODS, informes, referencias externas).
56
  - Mover a otra familia implicaria cambiar prefijo para evitar conflicto; debe definirse politica (bloqueo o renumeracion controlada por admin).
57
- Integracion ODS:
58
  - Columnas basicas recomendadas: `csID`, `Proyecto`, `Resumen`, `Tipo`, `Padre csID`, `Depende de csID`.
59
  - Validaciones: `Proyecto` solo admite proyectos de la familia; relaciones solo aceptan csID existentes en la misma familia.
60
  - Al importar se crean/actualizan items por csID y luego se resuelven relaciones por csID; csID ausentes generan error.
61
- Buenas practicas de prefijos:
62
  - 3–5 letras, sin guiones ni espacios; evitar siglas ambiguas con otros proyectos de la familia.
63
  - Revisar prefijos existentes antes de crear nuevos proyectos para prevenir colisiones.
64
- Errores comunes:
65
  - Prefijo duplicado en la familia: bloquear creacion y solicitar cambio.
66
  - csID no encontrado en importacion ODS: verificar prefijo del proyecto y que se importa en la familia correcta.
67
  - Relaciones a csID de otra familia: marcar error; mover el item objetivo a la familia o usar el ID interno si procede.
68 1 Txinto Vaz
69
## Plugins adicionales
70
- cosmoSys-Req: gestor profesional de requisitos; depende de cosmoSys y cosmoSys-Git.
71
- cosmoSys-PORIS: repositorio de modelos PORIS (comportamiento y configurabilidad); depende de cosmoSys y cosmoSys-Git.
72
- cosmoSys-Git: sincroniza un repositorio Git espejo de un proyecto para gestionar importaciones/exportaciones ODS y obtener instantaneas del proyecto; depende de cosmoSys.
73
74
## Diagramas
75
- Tipos:
76
  - Jerarquico: estructura padre-hijo como cajas dentro de cajas (equivalente a nodos expandidos en el arbol o capitulos/subcapitulos en MainReport/exportaciones).
77
  - Dependencias: relaciones dirigidas entre items (bloquea a / es bloqueado por, precede a / sucede a, copiado de / copiado en) y la relacion bidireccional "relacionado con" con flechas.
78
- Alcance:
79
  - Centrados en proyecto: desde el detalle del proyecto, un diagrama de cada tipo que incluye todos los items del proyecto, incluso los aislados sin padre o sin relaciones.
80
  - Centrados en un item: desde el detalle de un item, cada diagrama arranca en ese item y expande solo su entorno conectado; si no hay camino jerarquico o de relaciones hacia otro item, ese item y sus relaciones no se muestran.
81
82
La combinacion genera cuatro vistas: jerarquico del proyecto, dependencias del proyecto, jerarquico del item y dependencias del item.
83 4 Txinto Vaz
84
### Ejemplos de diagramas (instancia publica)
85
- Proyecto `MyProject` (sin autenticacion): diagrama de dependencias centrado en el proyecto  
86
  ![Diagrama de dependencias del proyecto MyProject](https://dev.csys.cosmobots.eu/cosmosys/tx-my/dep_gv.svg)
87
- Proyecto `MyProject`: diagrama jerarquico centrado en el proyecto  
88
  ![Diagrama jerarquico del proyecto MyProject](https://dev.csys.cosmobots.eu/cosmosys/tx-my/hie_gv.svg)
89
- Item `MY-0012` (MyProject): diagrama de dependencias centrado en el item  
90
  ![Diagrama de dependencias del item MY-0012](https://dev.csys.cosmobots.eu/cosmosys_issues/2030/dep_gv.svg)
91
- Item `MY-0012` (MyProject): diagrama jerarquico centrado en el item  
92
  ![Diagrama jerarquico del item MY-0012](https://dev.csys.cosmobots.eu/cosmosys_issues/2030/hie_gv.svg)
93 1 Txinto Vaz
94
## Flujo principal
95
1. _Acceso a cosmoSys y seleccion de un proyecto activo: Completar_
96 3 Txinto Vaz
2. _Busqueda (campo csID) o creacion de un item con csID dentro del proyecto/familia: Completar_
97 1 Txinto Vaz
3. _Exploracion en diagramas (jerarquico/dependencias), en la vista/editor de arbol o en MainReport para revisar y, si aplica, reorganizar la jerarquia y ajustar la visibilidad de campos: Completar_
98
99
## Roles y permisos
100
cosmoSys hereda el sistema de roles de Redmine y se adapta a la organizacion. Los nombres Manager, Colaborador y Lector son ejemplos tipicos de la configuracion base; las organizaciones suelen copiarlos, renombrarlos y ajustarlos (p.ej., "jefe de departamento", "jefe de proyecto" a partir de Manager; "ingeniero informatico", "ingeniero de sistemas", "tecnico de laboratorio" a partir de Colaborador; "interesado", "supervisor", "cliente" a partir de Lector).
101
102
| Ejemplo de rol | Que puede hacer | Restricciones |
103
| --- | ---------------- | ------------- |
104
| Manager de proyecto | Crear proyecto (si tiene permiso), configurar el equipo seleccionando usuarios y asignandoles roles (heredables si se define en configuracion), crear/editar items, ver la vista grafica completa | Solo en proyectos donde es manager; permisos de creacion otorgados por administrador |
105
| Colaborador | Actualizar items asignados, comentar, seguir relaciones en la vista | No modifica configuraciones de proyecto ni permisos |
106
| Lector | Ver items y relaciones | Sin edicion |
107
108
> Los roles son apilables: un usuario puede tener varios roles en un proyecto y sus permisos se suman. Puede haber varios usuarios con el mismo rol (incluido varios managers) o ninguno; si no hay manager, el administrador de cosmoSys/Redmine configura el equipo. Los equipos se definen por proyecto; pueden heredarse segun la configuracion que establezca el manager.
109
110
## Tareas frecuentes
111
Instrucciones paso a paso para las acciones mas comunes. Incluye capturas o comandos cuando apliquen.
112
113
### Reorganizar la jerarquia en la vista/editor de arbol
114
1. Accede al proyecto activo y abre la vista/editor de arbol.
115
2. Expande los subarboles necesarios para localizar el item a mover.
116
3. Arrastra el nodo y suelta sobre el nuevo padre o posicion permitida.
117
4. Verifica que la jerarquia se actualiza y que las relaciones esperadas se mantienen.
118
119
### Usar la vista MainReport
120
1. Accede al proyecto activo y abre la vista MainReport.
121
2. Configura los campos visibles y decide si mostrar los diagramas contextuales de cada item.
122
3. Aplica filtros para ocultar items por tipo o por valores de campos.
123
4. Navega el documento como capitulos/subcapitulos para revisar el contenido estructurado.
124
125
### Exportar MainReport a DOCX/ODT/HTML
126
1. Prepara la vista MainReport con campos y diagramas segun necesidad.
127
2. Elige el formato de salida (DOCX, ODT o HTML).
128
3. Selecciona la plantilla del informe (puedes usar las plantillas patron de cosmoBots o una propia adaptada a tu organizacion).
129
4. Genera el documento: se creara una tabla de contenidos viva, se incrustaran las imagenes/diagramas ajustados para no salir de pagina y se autogeneraran los capitulos de referencias (documentos de referencia, aplicables y de conformidad) con sus matrices.
130
131
## Referencias documentales (csInfo/csRef)
132
- Items csInfo sirven para estructurar contenidos en arbol (capitulos/secciones) arrastrando otros items dentro (p.ej., un csInfo "Bugs pendientes" conteniendo bugs abiertos). Son clases de item (trackers) pensadas para visualizar el proyecto como un libro.
133
- Items csRef apuntan a referencias bibliograficas o documentales (wiki, documentos, URLs, ficheros, citas) y se clasifican como documentos de referencia, aplicables o de conformidad.
134
- Cada item puede tener un listado de csRef asociados en esas tres categorias.
135
- MainReport y los informes exportados generan automaticamente los capitulos de referencias y las matrices que relacionan los documentos de referencia con los items.
136
137
## Casos de uso ampliados
138
Historias de usuario o escenarios completos con inicio y fin. _Completar_
139
140
## Personalizacion y configuracion
141
Opciones de ajustes, plantillas y preferencias. _Completar_
142
143
## Integraciones
144
### Importacion/exportacion ODS de items
145
- Plantillas ODS (cosmoBots provee ejemplos) preparadas para crear/revisar items con:
146
  - Desplegables para seleccionar relaciones de dependencia y campos no libres.
147
  - Vistas de revision tipo DSM (Design Structure Matrix) o diagrama de bloques.
148
  - Refuerzos semanticos para resaltar la jerarquia de nodos.
149
  - Reglas de validacion (p.ej., columna "Asignado a" solo permite miembros del proyecto).
150
- Pestana `Dict` define los terminos y listas usadas en validaciones.
151
- Pestana adicional para que el usuario agregue nombres de columnas extra a importar/exportar.
152
- Plantilla troncal disponible; se pueden aportar plantillas propias adaptadas.
153
154
### Herramientas de administracion y automatizacion
155
- Script de carga masiva que toma una WBS (paquetes de trabajo) de uno o varios proyectos grandes y genera la arquitectura en una o varias familias de proyecto.
156
- Hoja de carga con refuerzos visuales/semanticos para definir equipos, entregables y responsables de cada proyecto y entregable.
157
- El script crea tareas de kick-off, desarrollo y cierre, enlazadas con dependencias fin-inicio y asignadas a sus responsables.
158
- Script de carga de tareas desde plantilla: a partir de una tabla con tareas, estimaciones, asignados y relaciones, permite que el equipo revise dependencias, reorganice y vea carga de trabajo en la propia hoja. Luego crea las tareas en el proyecto, asigna, categoriza y aplica relaciones.
159
- Estas dos herramientas (hojas de calculo semanticas + scripts) facilitan levantar estructuras de proyectos o cargar un proyecto consensuado desde hojas de calculo.
160
161
## Resolucion de problemas
162
- Sintoma: _Completar_ → Solucion: _Completar_
163
- Sintoma: _Completar_ → Solucion: _Completar_
164
165
## Preguntas frecuentes
166
- _Pregunta frecuente_ → _Respuesta_
167
168
## Referencia rapida
169 3 Txinto Vaz
| Accion | Donde | Notas |
170
| --- | --- | --- |
171
| Crear csID | Nueva issue/item en el proyecto | Asigna siguiente numero de la secuencia del proyecto (prefijo-configurado). |
172
| Buscar csID | Buscador de csID en vista de proyecto/item | Recorre toda la familia; mensaje claro si no se encuentra. |
173
| Mover item | Arrastrar en vista de arbol | csID no cambia dentro de la familia. |
174
| Renombrar csID | Solo admin (accion especial) | Evitar salvo causa mayor; documentar cambios. |
175 1 Txinto Vaz
176
## Seguridad y buenas practicas
177
- cosmoBots no asume responsabilidad sobre la seguridad del servidor cosmoSys ni de su contenido: se recomienda instalarlo en intranet o bajo VPN de la organizacion y combinarlo con una politica de respaldos.
178
- La organizacion debe decidir el equilibrio entre proteccion y facilidad de acceso para su equipo.
179
- Existen terceros (normalmente empresas) que pueden ofrecer alojamiento y mantenimiento con garantias de seguridad; evalue esas opciones si no hay infraestructura propia.
180
181
## Soporte y escalamiento
182
- Instancia publica para tickets de cosmoSys (bugs y desarrollo): https://support.csys.cosmobots.eu/projects/csys-issues/issues
183
- Canales de reporte: chat de soporte en Telegram; email de soporte de cosmoBots; o solicitud de usuario para reportar directamente en la instancia.
184
- _Completar con horarios/SLA/contactos especificos si aplican._
185
186
## Bitacora de cambios
187
- Version _X.Y_: _Resumen de cambios_
188
189
## Apendices
190
Material extra: glosario, formatos de archivo, plantillas de ejemplo. _Completar_
Go to top